com.brightech.mb.workflow.js

Class ACL

java.lang.Object

org.mozilla.javascript.ScriptableObject

com.brightech.xmp.js.MBScriptableObject

com.brightech.xmp.js.ReleasableScriptableObject

com.brightech.mb.workflow.js.JSBaseScriptableObject

com.brightech.mb.workflow.js.ACL

All Implemented Interfaces:

java.io.Serializable, org.mozilla.javascript.ConstProperties, org.mozilla.javascript.ContextFactory.Listener, org.mozilla.javascript.debug.DebuggableObject, org.mozilla.javascript.Scriptable

public class ACL
extends JSBaseScriptableObject

A Javascript object representing an ACL.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.mozilla.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface org.mozilla.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
ACL()

Method Summary

Modifier and Type	Method and Description
void	jsConstructor(java.lang.String theACLId) Provides an js ACL given the acl id
void	(JavaScript Function) addWorkspace(Workspace theWorkspace, java.lang.String theDisplayName, boolean theIsHidden, int theOrder) Make the given workspace available to this ACL.
CriteriaWrapper	(JavaScript Function) getACLSearchClause() Get the search from this ACL
ManagedFolder	(JavaScript Function) getRoot() Get this ACL's root folder.
java.lang.String	(JavaScript Function) getRootPath() Get this ACL's root path.
java.lang.String	(JavaScript Function) getStandardUploadPath(java.lang.String theUploadRootDirname, User theUser) Get the standard upload path when uploading to this ACL, the time stamp portion is generated when this function is called.
CriteriaWrapper	(JavaScript Function) getWhereClause() Deprecated.
java.lang.String	(JavaScript Function) getWorkspaceDisplayName(java.lang.String theWorkspaceId) Get the ACL-specific display name used for the given workspace id.
int	(JavaScript Function) getWorkspaceOrder(java.lang.String theWorkspaceId) Get the ACL-specific display order for the given workspace id.
Workspace[]	(JavaScript Function) getWorkspaces() Get all workspaces available to this ACL.
boolean	(JavaScript Function) hasDownloadPermission(User theUser, ManagedFile theManagedFile) Is the given user using this ACL able to download the given managed file?
boolean	(JavaScript Function) hasPermission(java.lang.String thePermission, ManagedFile theManagedFile, User theUser) Does the given user using this ACL have the given permission to access the given managed file (if specified)? Can be used to check asset-dependant permissions (e.g.
boolean	(JavaScript Function) isWorkspaceHidden(java.lang.String theWorkspaceId) Is the workspace with given id hidden for this ACL.
void	(JavaScript Function) removeWorkspace(Workspace theWorkspace) Make the given workspace no longer available to this ACL.
void	(JavaScript Function) setName(java.lang.String theACLName)
void	(JavaScript Function) setRoot(IFolderObject theRootFolder) Set this ACL's root folder.
void	(JavaScript Function) write() Writes this ACL object back to the database.
java.lang.String	(JavaScript Getter) id() Returns the ACL's id.
java.lang.String	(JavaScript Getter) name() Returns the ACL's name.
int	(JavaScript Getter) type() Returns the ACL type: 0 for group, 1 for user.
int	(JavaScript Getter) userOrGroupId() If this is a group-type ACL, the id of the group this ACL belongs to will be returned.

Methods inherited from class org.mozilla.javascript.ScriptableObject

associateValue, avoidObjectDetection, callMethod, callMethod, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, deleteProperty, deleteProperty, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getClassName, getClassPrototype, getDefaultValue, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getParentScope, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, hasInstance, hasProperty, hasProperty, isConst, isEmpty, isExtensible, isSealed, preventExtensions, put, put, putConst, putConstProperty, putProperty, putProperty, redefineProperty, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setExternalArrayData, setGetterOrSetter, setParentScope, setPrototype, size

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.mozilla.javascript.ContextFactory.Listener

contextCreated, contextReleased

Constructor Detail

ACL

public ACL()

Method Detail

jsConstructor

public void jsConstructor(java.lang.String theACLId)

Provides an js ACL given the acl id

Parameters:

theACLId -

(JavaScript Getter) id

public java.lang.String (JavaScript Getter) id()

Returns the ACL's id.

Returns:

String

(JavaScript Getter) name

public java.lang.String (JavaScript Getter) name()

Returns the ACL's name.

Returns:

String

(JavaScript Function) setName

public void (JavaScript Function) setName(java.lang.String theACLName)

(JavaScript Getter) type

public int (JavaScript Getter) type()

Returns the ACL type: 0 for group, 1 for user.

Returns:

int

(JavaScript Getter) userOrGroupId

public int (JavaScript Getter) userOrGroupId()

If this is a group-type ACL, the id of the group this ACL belongs to will be returned. Otherwise if this is an user-type ACL, the id of the user this ACL belongs to will be returned.

Returns:

The id of the group or user that owns this ACL.

(JavaScript Function) getRoot

public ManagedFolder (JavaScript Function) getRoot()

Get this ACL's root folder.

Returns:

This ACL's root folder.

(JavaScript Function) getRootPath

public java.lang.String (JavaScript Function) getRootPath()

Get this ACL's root path.

Returns:

This ACL's root path.

(JavaScript Function) setRoot

public void (JavaScript Function) setRoot(IFolderObject theRootFolder)

Set this ACL's root folder.

Parameters:

theRootFolder - This ACL's new root folder.

(JavaScript Function) getStandardUploadPath

public java.lang.String (JavaScript Function) getStandardUploadPath(java.lang.String theUploadRootDirname,
                                                         User theUser)

Get the standard upload path when uploading to this ACL, the time stamp portion is generated when this function is called.

Parameters:

theUploadRootDirname - The name of upload folder.

theUser - the uploading user.

Returns:

The standard upload path when uploading to this ACL.

(JavaScript Function) getWorkspaces

public Workspace[] (JavaScript Function) getWorkspaces()

Get all workspaces available to this ACL.

Returns:

All workspaces available to this ACL.

(JavaScript Function) removeWorkspace

public void (JavaScript Function) removeWorkspace(Workspace theWorkspace)

Make the given workspace no longer available to this ACL. If the given workspace is already not available to this ACL, this function has no effect.

Parameters:

theWorkspace - The workspace that should no longer be available to this ACL.

(JavaScript Function) addWorkspace

public void (JavaScript Function) addWorkspace(Workspace theWorkspace,
                                    java.lang.String theDisplayName,
                                    boolean theIsHidden,
                                    int theOrder)

Make the given workspace available to this ACL.

Parameters:

theWorkspace - The workspace to make available to this ACL.

theDisplayName - The name to use for this workspace for this ACL.

theIsHidden - Should the given workspace be visible to this ACL?

theOrder - The order the given workspace should be displayed in this ACL.

(JavaScript Function) getWorkspaceDisplayName

public java.lang.String (JavaScript Function) getWorkspaceDisplayName(java.lang.String theWorkspaceId)

Get the ACL-specific display name used for the given workspace id. If the given workspace does not exist or isn't available to this ACL, an IllegalArgumentException is thrown.

Parameters:

theWorkspaceId - The id of the workspace to get this ACL's display name for.

Returns:

The ACL-specific display name used for the given workspace id.

(JavaScript Function) getWorkspaceOrder

public int (JavaScript Function) getWorkspaceOrder(java.lang.String theWorkspaceId)

Get the ACL-specific display order for the given workspace id. If the given workspace does not exist or isn't available to this ACL, an IllegalArgumentException is thrown.

Parameters:

theWorkspaceId - The id of the workspace to get this ACL's display order for.

Returns:

The ACL-specific display order for the given workspace id.

(JavaScript Function) isWorkspaceHidden

public boolean (JavaScript Function) isWorkspaceHidden(java.lang.String theWorkspaceId)

Is the workspace with given id hidden for this ACL. If the given workspace does not exist or isn't available to this ACL, an IllegalArgumentException is thrown.

Parameters:

theWorkspaceId - The id of the workspace to get this ACL's hidden status for.

Returns:

Is the workspace with given id hidden for this ACL?

(JavaScript Function) hasPermission

public boolean (JavaScript Function) hasPermission(java.lang.String thePermission,
                                        ManagedFile theManagedFile,
                                        User theUser)

Does the given user using this ACL have the given permission to access the given managed file (if specified)? Can be used to check asset-dependant permissions (e.g. edit metadata, replace, view log, download hi-res etc.).

Parameters:

thePermission - The permission to check.

theManagedFile - The managed file to check. Use null to check the current user's permission independent of a particular asset.

theUser - The user to check. Ignored if theFile is null.

Returns:

Does the given user using this ACL have access to the given managed file with the given permissions?

(JavaScript Function) hasDownloadPermission

public boolean (JavaScript Function) hasDownloadPermission(User theUser,
                                                ManagedFile theManagedFile)

Is the given user using this ACL able to download the given managed file?

Parameters:

theUser - The user to check.

theManagedFile - The managed file to check.

Returns:

Is the given user using this ACL able to download the given managed file?

(JavaScript Function) getWhereClause

@Deprecated
public CriteriaWrapper (JavaScript Function) getWhereClause()
                                                      throws java.lang.Exception

Deprecated.

Get the where clause from this ACL

Returns:

the where clause

Throws:

java.lang.Exception - error getting where clause

(JavaScript Function) getACLSearchClause

public CriteriaWrapper (JavaScript Function) getACLSearchClause()
                                              throws java.lang.Exception

Get the search from this ACL

Returns:

the search clause

Throws:

java.lang.Exception - error getting search clause

(JavaScript Function) write

public void (JavaScript Function) write()

Writes this ACL object back to the database.