com.appiancorp.suiteapi.applications

Class ApplicationRoleMap

java.lang.Object

com.appiancorp.suiteapi.applications.ApplicationRoleMap

public class ApplicationRoleMap
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ApplicationRoleMap()
ApplicationRoleMap(ContentRoleMap securityRoleMap)

Method Summary

Modifier and Type	Method and Description
java.lang.Long[]	getAdministratorGroups() Retrieves the groups who have administrative permissions.
java.lang.String[]	getAdministrators() Retrieves the users who have administrative permissions.
ContentRoleMap	getContentRoleMap()
java.lang.String[]	getDeny() The users in the deny role.
java.lang.Long[]	getDenyGroups() The list of groups in the deny role.
java.lang.Long[]	getEditorGroups() Retrieves the groups who have authoring (read/write) permissions.
java.lang.String[]	getEditors() Retrieves the users who have editor (read/write) permissions.
java.lang.Long[]	getViewerGroups() Retrieves the groups who have read-only permissions.
java.lang.String[]	getViewers() Retrieves the users who have read-only permissions.
void	setAdministratorGroups(java.lang.Long[] groupIds) Sets the groups who have administrative permissions.
void	setAdministrators(java.lang.String[] usernames) Sets the users who have administrative permissions.
void	setContentRoleMap(ContentRoleMap crm)
void	setDeny(java.lang.String[] usernames) A user assigned to the "Deny" level, either directly or via group membership, will NOT have ANY privileges on the application, regardless of membership in any other security level.
void	setDenyGroups(java.lang.Long[] groupIds) A group assigned to the "Deny" level, will NOT have ANY privileges on the application, regardless of membership in any other security level.
void	setEditorGroups(java.lang.Long[] groupIds) Sets the groups who have editor (read/write) permissions.
void	setEditors(java.lang.String[] usernames) Sets the users who have authoring (read/write) permissions.
void	setViewerGroups(java.lang.Long[] groupIds) Sets the groups who have read-only permissions.
void	setViewers(java.lang.String[] usernames) Sets the users who have read-only permissions.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ApplicationRoleMap

public ApplicationRoleMap()

ApplicationRoleMap

public ApplicationRoleMap(ContentRoleMap securityRoleMap)

Method Detail

getAdministrators

public java.lang.String[] getAdministrators()

Retrieves the users who have administrative permissions.

Returns:

a list containing the unique IDs of the users

See Also:

setAdministrators(String[])

getAdministratorGroups

public java.lang.Long[] getAdministratorGroups()

Retrieves the groups who have administrative permissions.

Returns:

a list containing the unique IDs of the groups

See Also:

setAdministratorGroups(Long[])

setAdministrators

public void setAdministrators(java.lang.String[] usernames)

Sets the users who have administrative permissions.

Parameters:

usernames - a list containing the usernames

See Also:

getAdministrators()

setAdministratorGroups

public void setAdministratorGroups(java.lang.Long[] groupIds)

Sets the groups who have administrative permissions.

Parameters:

groupIds - a list containing the ids of the groups

See Also:

getAdministratorGroups()

getEditors

public java.lang.String[] getEditors()

Retrieves the users who have editor (read/write) permissions.

Returns:

a list containing the unique IDs of the users who have editor (read/write) permissions

setEditors

public void setEditors(java.lang.String[] usernames)

Sets the users who have authoring (read/write) permissions.

Parameters:

usernames - a list containing the unique IDs of the users

See Also:

#getAuthors()

getEditorGroups

public java.lang.Long[] getEditorGroups()

Retrieves the groups who have authoring (read/write) permissions.

Returns:

a list containing the unique IDs of the groups

See Also:

#setAuthorGroups(Long[])

setEditorGroups

public void setEditorGroups(java.lang.Long[] groupIds)

Sets the groups who have editor (read/write) permissions.

Parameters:

groupIds - a list containing the group ids.

getViewers

public java.lang.String[] getViewers()

Retrieves the users who have read-only permissions.

Returns:

a list containing the unique IDs of the users who have read-only permissions

getViewerGroups

public java.lang.Long[] getViewerGroups()

Retrieves the groups who have read-only permissions.

Returns:

a list containing the unique IDs the groups who have read-only permissions

See Also:

#setReaderGroups(Long[])

setViewers

public void setViewers(java.lang.String[] usernames)

Sets the users who have read-only permissions.

Parameters:

usernames - a list containing the unique IDs of the users

setViewerGroups

public void setViewerGroups(java.lang.Long[] groupIds)

Sets the groups who have read-only permissions.

Parameters:

groupIds - a list containing the unique IDs of the groups

setDeny

public void setDeny(java.lang.String[] usernames)

A user assigned to the "Deny" level, either directly or via group membership, will NOT have ANY privileges on the application, regardless of membership in any other security level. "Deny" also overrides implicit viewer privileges granted by the "public" configuration. The exception is a System Administrator, whose privileges may not be overridden.

Parameters:

usernames - The list of usernames to be added to the Deny role.

getDeny

public java.lang.String[] getDeny()

The users in the deny role.

Returns:

The users in the deny role.

See Also:

setDeny

setDenyGroups

public void setDenyGroups(java.lang.Long[] groupIds)

A group assigned to the "Deny" level, will NOT have ANY privileges on the application, regardless of membership in any other security level. "Deny" also overrides implicit viewer privileges granted by the "public" configuration. The exception is a System Administrator, whose privileges may not be overridden.

Parameters:

groupIds - The list of groups to be added to the Deny role.

getDenyGroups

public java.lang.Long[] getDenyGroups()

The list of groups in the deny role.

Returns:

the list of groups in the deny role.

getContentRoleMap

public ContentRoleMap getContentRoleMap()

setContentRoleMap

public void setContentRoleMap(ContentRoleMap crm)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object