com.hyperion.css.common
Interface CSSNativeRoleIF

All Superinterfaces:

CSSRoleIF, java.io.Serializable

public interface CSSNativeRoleIF
extends CSSRoleIF

This interface encapsulates the functionality for creating and managing roles in the native directory.

Since:

CSS 3.0

Author:

gkhanna

Field Summary

Fields inherited from interface com.hyperion.css.common.CSSRoleIF

OBJECTID

Method Summary

void	addProductType(java.lang.String productType) Adds the product code and version => the type of the Hyperion Product that this role is associated with.
void	setDescription(java.lang.String description) Sets the description for this role.
void	setName(java.lang.String name) Sets the name for this role for the default locale.
void	setRoleInfo(java.util.Map roleInfo) Sets associated information for this role.
void	setRoleTree(java.lang.String[] rolesIdentities, boolean add) Assigns the following roles as contained in this role.

Methods inherited from interface com.hyperion.css.common.CSSRoleIF

getDescription, getIdentity, getName, getParentRoles, getProductTypes, getRoleInfo, getRoleTree, isPreConfigured

Method Detail

setName

void setName(java.lang.String name)

Sets the name for this role for the default locale.

Parameters:

name - - name for the role

setDescription

void setDescription(java.lang.String description)

Sets the description for this role.

Parameters:

description - - description for the role

setRoleInfo

void setRoleInfo(java.util.Map roleInfo)

Sets associated information for this role.

Parameters:

roleInfo - - a map of role related information

addProductType

void addProductType(java.lang.String productType)

Adds the product code and version => the type of the Hyperion Product that this role is associated with. For instance: HFM-3_0

Parameters:

productType - CSSNativeRoleIF instance

setRoleTree

void setRoleTree(java.lang.String[] rolesIdentities,
                 boolean add)
                 throws CSSCircularDependencyException,
                        CSSException

Assigns the following roles as contained in this role.

This method denies any assignment that would lead to a circular dependency. If any of the parent roles are either directly or indirectly associated with this role as a parent or as a child then this method fails with a CSSCircularDependecyException.

Please note that there no duplicate role membership is persisted even if it is passed in the roles argument.

Parameters:

rolesIdentities - The list of base roles.

add - If true, then the roles are added to the existing roles that are contained by this role. Otherwise, the existing roles membership is replaced.

Throws:

CSSCircularDependencyException - If a circular dependency is detected, then this exception is thrown.

CSSException - If there is any other abnormality.