com.hyperion.css.common
Interface CSSRoleIF

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

CSSNativeRoleIF

public interface CSSRoleIF
extends java.io.Serializable

This interface is used to depict a "role" and holds properties that classify that role and underlies its importance in the authorization process.

Since:

CSS 3.0

Field Summary

static java.lang.String

OBJECTID

Method Summary

java.lang.String	getDescription() Gets the description for this role.
java.lang.String	getIdentity() The identity of the role is specified by the instance id that is generated by the product to register the applications.
java.lang.String	getName() Gets the name of this role.
java.util.Set	getParentRoles(CSSPrincipalIF principal, boolean indirect) Returns the Parent roles of this role.
java.lang.String[]	getProductTypes() This is an EPM mode only API.
java.util.Map	getRoleInfo() This is an EPM mode only API.
java.lang.String[]	getRoleTree(CSSPrincipalIF principal, boolean indirect) This is an EPM mode only API.
boolean	isPreConfigured() This is an EPM mode only API.

Field Detail

OBJECTID

static final java.lang.String OBJECTID

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

Gets the name of this role. This is a localized String.

Returns:

getDescription

java.lang.String getDescription()

Gets the description for this role. This is a localized String.

Returns:

String

getIdentity

java.lang.String getIdentity()

The identity of the role is specified by the instance id that is generated by the product to register the applications.

The identity does not need to be localized, as it is required to be unique and stable in terms of being impervious to the effects of geographical location or the language.

Returns:

String

getProductTypes

java.lang.String[] getProductTypes()
                                   throws CSSException

This is an EPM mode only API.

Gets the product code and version => the type of the Hyperion Product that this role is associated with.

Throws:

CSSMethodNotSupportedException - - if this method is not supported for a particular CSS mode.

CSSException - - if there was any other abnormality

getRoleInfo

java.util.Map getRoleInfo()
                          throws CSSException

This is an EPM mode only API.

Gets associated information for this role.

Returns:

Map

Throws:

CSSMethodNotSupportedException - - if this method is not supported for a particular CSS mode.

CSSException - - if there was any other abnormality

isPreConfigured

boolean isPreConfigured()
                        throws CSSException

This is an EPM mode only API.

Returns true if this role is preconfigured. A preconfigured role is not available for updates. A role is said to be preconfigured if it is registered with Hyperion Shared Services.

Returns:

True if the role is preconfigured.

Throws:

CSSMethodNotSupportedException - - if this method is not supported for a particular CSS mode.

CSSException - - if there was any other abnormality

getRoleTree

java.lang.String[] getRoleTree(CSSPrincipalIF principal,
                               boolean indirect)
                               throws CSSCommunicationException,
                                      CSSException

This is an EPM mode only API.

Returns the contained roles if this is an aggregated role. If there is a role hierarchy, then this method returns the derived roles for this base role.

Parameters:

principal - The caller invoking this method.

indirect - If true, returns the complete hierarchy.

Returns:

Array of role identities.

Throws:

CSSException

CSSCommunicationException

getParentRoles

java.util.Set getParentRoles(CSSPrincipalIF principal,
                             boolean indirect)
                             throws CSSException

Returns the Parent roles of this role.

Returns:

Throws:

CSSException