oracle.iam.platform.entitymgr.vo

Class EntityDefinition

java.lang.Object

oracle.iam.platform.entitymgr.vo.EntityDefinition

public final class EntityDefinition
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
EntityDefinition(java.lang.String entityType)

Method Summary

Modifier and Type	Method and Description
void	addAttribute(AttributeDefinition def)
void	addChildEntity(AttributeDefinition def)
void	addContainedEntity(java.lang.String entityType) Add an entity type to the set of entity types that can be contained in this container.
void	addControlAttribute(ControlAttributeDefinition def)
void	AttachMetadata(java.util.Map metaAttachment)
java.util.Map	getAttachedMetadata() Get all attached metadata
java.util.Map	getAttachedMetadata(java.lang.String category) Get all attached metadata of a specific category
AttributeDefinition	getAttributeDefinition(java.lang.String attrName) Get the attribute definition of a specific attribute
java.util.HashMap	getAttributeDefinitions() Get the attribute definitions of all attributes
java.lang.String	getAttributeGroupName(java.lang.String attrName) Get the attribute group name of a specific attribute
java.util.Set	getAttributeGroupNames() Get the list of attribute group names
java.util.Set	getAttributeNames() Get all the attribute names
java.util.Set	getAttributeNames(java.lang.String attrGroupName) Get all the attribute names of a specific attribute group
AttributeDefinition	getChildEntityAttributeDefinition(java.lang.String ceName) Get child entity attribute definition of a specific child entity
java.util.HashMap	getChildEntityAttributeDefinitions() Get all child entity attribute definitions
java.util.Set	getChildEntityNames() Get all child entity names
java.util.Set	getContainedEntities() Get the set of entity types that can be contained in this container.
ControlAttributeDefinition	getControlAttributeDefinition(java.lang.String attrName) Get the attribute definition of a specific control attribute
java.util.HashMap	getControlAttributeDefinitions() Get the attribute definitions of all control attributes
java.lang.String	getEntityType() Get the entity type
java.util.Set	getMLSAttributeNames() Get all the MLS attribute names
java.util.Set	getMultiRepresentedAttributeNames() Get all the MLS attribute names
java.util.Set	getMultiValuedAttributeNames() Get all the Multi Valued attribute (MVA) names
java.util.Set	getRequiredAttributeNames() Get all the required attribute names
boolean	isContainer() Check if it is a container.
void	setContainer(boolean isContainer) Sets whether or not it is a container.

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityDefinition

public EntityDefinition(java.lang.String entityType)

Parameters:

entityType -

Method Detail

getEntityType

public java.lang.String getEntityType()

Get the entity type

Returns:

the entity type

isContainer

public boolean isContainer()

Check if it is a container.

Returns:

true if it is a container

setContainer

public void setContainer(boolean isContainer)

Sets whether or not it is a container.

Parameters:

isContainer -

addControlAttribute

public void addControlAttribute(ControlAttributeDefinition def)

Parameters:

def -

addAttribute

public void addAttribute(AttributeDefinition def)

Parameters:

def -

getAttributeNames

public java.util.Set getAttributeNames()

Get all the attribute names

Returns:

all the attribute names

getRequiredAttributeNames

public java.util.Set getRequiredAttributeNames()

Get all the required attribute names

Returns:

all the required attribute names

getChildEntityNames

public java.util.Set getChildEntityNames()

Get all child entity names

Returns:

all child entity names

getChildEntityAttributeDefinition

public AttributeDefinition getChildEntityAttributeDefinition(java.lang.String ceName)

Get child entity attribute definition of a specific child entity

Parameters:

ceName - the child entity name

Returns:

the child entity attribute definition

getMLSAttributeNames

public java.util.Set getMLSAttributeNames()

Get all the MLS attribute names

Returns:

all the MLS attribute names

getMultiValuedAttributeNames

public java.util.Set getMultiValuedAttributeNames()

Get all the Multi Valued attribute (MVA) names

Returns:

all the Multi Valued attribute (MVA) names

getAttributeDefinition

public AttributeDefinition getAttributeDefinition(java.lang.String attrName)

Get the attribute definition of a specific attribute

Parameters:

attrName - attribute name

Returns:

the attribute definition of the attribute

getAttributeDefinitions

public java.util.HashMap getAttributeDefinitions()

Get the attribute definitions of all attributes

Returns:

the attribute definitions of all the attributes

getAttachedMetadata

public java.util.Map getAttachedMetadata(java.lang.String category)

Get all attached metadata of a specific category

Parameters:

category - category name

Returns:

all attached metadata of the category

getControlAttributeDefinition

public ControlAttributeDefinition getControlAttributeDefinition(java.lang.String attrName)

Get the attribute definition of a specific control attribute

Parameters:

attrName - attribute name

Returns:

the attribute definition of the control attribute

getControlAttributeDefinitions

public java.util.HashMap getControlAttributeDefinitions()

Get the attribute definitions of all control attributes

Returns:

the attribute definitions of all the control attributes

getAttributeNames

public java.util.Set getAttributeNames(java.lang.String attrGroupName)

Get all the attribute names of a specific attribute group

Parameters:

attrGroupName - attribute group name

Returns:

all the attribute names of the attribute group

getAttributeGroupName

public java.lang.String getAttributeGroupName(java.lang.String attrName)

Get the attribute group name of a specific attribute

Parameters:

attrName - attribute name

Returns:

the attribute group name that attrName belongs to

getChildEntityAttributeDefinitions

public java.util.HashMap getChildEntityAttributeDefinitions()

Get all child entity attribute definitions

Returns:

all the child entity attribute definitions

getAttributeGroupNames

public java.util.Set getAttributeGroupNames()

Get the list of attribute group names

Returns:

the list of attribute group name

getMultiRepresentedAttributeNames

public java.util.Set getMultiRepresentedAttributeNames()

Get all the MLS attribute names

Returns:

all the MLS attribute names

getContainedEntities

public java.util.Set getContainedEntities()
                                   throws java.lang.UnsupportedOperationException

Get the set of entity types that can be contained in this container.

Returns:

the set of entity types that can be contained in this container

Throws:

java.lang.UnsupportedOperationException - if the entity metadata object does not represents a container

addContainedEntity

public void addContainedEntity(java.lang.String entityType)
                        throws java.lang.UnsupportedOperationException

Add an entity type to the set of entity types that can be contained in this container.

Parameters:

entityType - the entity type to be added

Throws:

java.lang.UnsupportedOperationException - if the entity metadata object does not represents a container

addChildEntity

public void addChildEntity(AttributeDefinition def)

Parameters:

def -

getAttachedMetadata

public java.util.Map getAttachedMetadata()

Get all attached metadata

Returns:

all attached metadata in a Map with category names as keys to the Map and the metadata name-value pairs as values

AttachMetadata

public void AttachMetadata(java.util.Map metaAttachment)

Parameters:

metaAttachment -