RelationMetadata (Oracle Fusion Middleware Java API Reference for Oracle Identity Manager)

java.lang.Object
- oracle.iam.platform.entitymgr.vo.RelationMetadata

All Implemented Interfaces:: oracle.iam.platform.utils.XmlObject

public class RelationMetadata
extends java.lang.Object
implements oracle.iam.platform.utils.XmlObject

Constructor Summary

Constructors
Constructor and Description
`RelationMetadata()` Constructor for Kernel use to generate the relation metadata from XML only! Use the other constructor RelationMetadata(String relationType) for any other purposes.
`RelationMetadata(java.lang.String relationType)` Construct an empty relation metadata object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAttribute(AttributeDefinition attrDef)` Add or modify an attribute.
`void`	`addAttributeMapping(java.lang.String attrName, java.lang.String fieldName)` Add or modify an attribute mapping.
`void`	`addField(FieldDefinition fieldDef)` Add or modify an target field.
`void`	`generateObject(org.w3c.dom.Document doc)`
`org.w3c.dom.Document`	`generateXml()`
`AttributeDefinition`	`getAttribute(java.lang.String attrName)` Get a attribute definition
`java.lang.String`	`getAttributeGroupName1()` Get the attribute group name for entity 1
`java.lang.String`	`getAttributeGroupName2()` Get the attribute group name for entity 2
`java.util.Map`	`getAttributeMap()` Get the attribute map
`java.lang.String`	`getAttributeName1()` Get the attribute name for entity 1
`java.lang.String`	`getAttributeName2()` Get the attribute name for entity 2
`java.lang.String`	`getAttributeNameInEntity1()` Get the attribute name in the specified entity type for entity 1
`java.lang.String`	`getAttributeNameInEntity2()` Get the attribute name in the specified entity type for entity 2
`java.util.Map`	`getAttributes()` Get all the attribute definitions
`java.lang.String`	`getEntityType1()` Get the entity type for entity 1
`java.lang.String`	`getEntityType2()` Get the entity type for entity 2
`FieldDefinition`	`getField(java.lang.String fieldName)` Get a target field definition
`java.util.Map`	`getFields()` Get all the target field definitions
`java.util.Map`	`getProviderParameters()` Get the relation provider parameters.
`java.lang.String`	`getProviderType()` Get the relation provider type name.
`java.lang.String`	`getRelationType()` Get the relation type
`java.lang.String`	`getRepositoryInstance()` Get the repository instance name.
`void`	`removeAttribute(java.lang.String attrName)` Remove an attribute.
`void`	`removeAttributeMapping(java.lang.String attrName)` Remove an attribute mapping.
`void`	`removeField(java.lang.String fieldName)` Remove an target field.
`void`	`setAttributeGroupName1(java.lang.String attrGroupName)` Set the attribute group name for entity 1
`void`	`setAttributeGroupName2(java.lang.String attrGroupName)` Set the attribute group name for entity 2
`void`	`setAttributeMap(java.util.Map attrMap)` Set the attribute map
`void`	`setAttributeName1(java.lang.String attrName)` Set the attribute name for entity 1
`void`	`setAttributeName2(java.lang.String attrName)` Set the attribute name for entity 2
`void`	`setAttributeNameInEntity1(java.lang.String attrName)` Set the attribute name in the specified entity type for entity 1
`void`	`setAttributeNameInEntity2(java.lang.String attrName)` Set the attribute name in the specified entity type for entity 2
`void`	`setEntityType1(java.lang.String entityType)` Set the entity type for entity 1
`void`	`setEntityType2(java.lang.String entityType)` Set the entity type for entity 2
`void`	`setProviderParameters(java.util.Map providerParams)` Set the relation provider parameters.
`void`	`setProviderType(java.lang.String providerType)` Set the relation provider type name.
`void`	`setRepositoryInstance(java.lang.String reposInstance)` Set the repository instance name.
`org.w3c.dom.Document`	`toDocument()` Convert the relation metadata object into a XML document

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RelationMetadata
```
public RelationMetadata()
```
    Constructor for Kernel use to generate the relation metadata from XML only! Use the other constructor RelationMetadata(String relationType) for any other purposes.
  - RelationMetadata
```
public RelationMetadata(java.lang.String relationType)
```
    Construct an empty relation metadata object.
    
    Parameters:
    
    relationType - the relation type
- Method Detail
  - getRelationType
```
public java.lang.String getRelationType()
```
    Get the relation type
    
    Returns:
    
    the relation type
  - getRepositoryInstance
```
public java.lang.String getRepositoryInstance()
```
    Get the repository instance name.
    
    Returns:
    
    the repository instance name
  - setRepositoryInstance
```
public void setRepositoryInstance(java.lang.String reposInstance)
```
    Set the repository instance name.
    
    Parameters:
    
    reposInstance - the repository instance name
  - getProviderType
```
public java.lang.String getProviderType()
```
    Get the relation provider type name.
    
    Returns:
    
    the relation provider type name
  - setProviderType
```
public void setProviderType(java.lang.String providerType)
```
    Set the relation provider type name.
    
    Parameters:
    
    providerType - the relation provider type name
  - getProviderParameters
```
public java.util.Map getProviderParameters()
```
    Get the relation provider parameters.
    
    Returns:
    
    the relation provider parameters
  - setProviderParameters
```
public void setProviderParameters(java.util.Map providerParams)
```
    Set the relation provider parameters.
    
    Parameters:
    
    providerParams - the relation provider parameters
  - getEntityType1
```
public java.lang.String getEntityType1()
```
    Get the entity type for entity 1
    
    Returns:
    
    the entity type for entity 1
  - setEntityType1
```
public void setEntityType1(java.lang.String entityType)
```
    Set the entity type for entity 1
    
    Parameters:
    
    entityType - the entity type for entity 1
  - getAttributeName1
```
public java.lang.String getAttributeName1()
```
    Get the attribute name for entity 1
    
    Returns:
    
    the attribute name for entity 1
  - setAttributeName1
```
public void setAttributeName1(java.lang.String attrName)
```
    Set the attribute name for entity 1
    
    Parameters:
    
    attrName - the attribute name for entity 1
  - getAttributeNameInEntity1
```
public java.lang.String getAttributeNameInEntity1()
```
    Get the attribute name in the specified entity type for entity 1
    
    Returns:
    
    the the attribute name in the specified entity type for entity 1
  - setAttributeNameInEntity1
```
public void setAttributeNameInEntity1(java.lang.String attrName)
```
    Set the attribute name in the specified entity type for entity 1
    
    Parameters:
    
    attrName - the the attribute name in the specified entity type for entity 1
  - getAttributeGroupName1
```
public java.lang.String getAttributeGroupName1()
```
    Get the attribute group name for entity 1
    
    Returns:
    
    the attribute group name for entity 1
  - setAttributeGroupName1
```
public void setAttributeGroupName1(java.lang.String attrGroupName)
```
    Set the attribute group name for entity 1
    
    Parameters:
    
    attrGroupName - the attribute group name for entity 1
  - getEntityType2
```
public java.lang.String getEntityType2()
```
    Get the entity type for entity 2
    
    Returns:
    
    the entity type for entity 2
  - setEntityType2
```
public void setEntityType2(java.lang.String entityType)
```
    Set the entity type for entity 2
    
    Parameters:
    
    entityType - the entity type for entity 2
  - getAttributeName2
```
public java.lang.String getAttributeName2()
```
    Get the attribute name for entity 2
    
    Returns:
    
    the attribute name for entity 2
  - setAttributeName2
```
public void setAttributeName2(java.lang.String attrName)
```
    Set the attribute name for entity 2
    
    Parameters:
    
    attrName - the attribute name for entity 2
  - getAttributeNameInEntity2
```
public java.lang.String getAttributeNameInEntity2()
```
    Get the attribute name in the specified entity type for entity 2
    
    Returns:
    
    the the attribute name in the specified entity type for entity 2
  - setAttributeNameInEntity2
```
public void setAttributeNameInEntity2(java.lang.String attrName)
```
    Set the attribute name in the specified entity type for entity 2
    
    Parameters:
    
    attrName - the the attribute name in the specified entity type for entity 2
  - getAttributeGroupName2
```
public java.lang.String getAttributeGroupName2()
```
    Get the attribute group name for entity 2
    
    Returns:
    
    the attribute group name for entity 2
  - setAttributeGroupName2
```
public void setAttributeGroupName2(java.lang.String attrGroupName)
```
    Set the attribute group name for entity 2
    
    Parameters:
    
    attrGroupName - the attribute group name for entity 2
  - getAttributes
```
public java.util.Map getAttributes()
```
    Get all the attribute definitions
    
    Returns:
    
    all the attribute definitions
  - getAttribute
```
public AttributeDefinition getAttribute(java.lang.String attrName)
```
    Get a attribute definition
    
    Parameters:
    
    attrName - the attribute name
    
    Returns:
    
    the attribute definition
  - addAttribute
```
public void addAttribute(AttributeDefinition attrDef)
```
    Add or modify an attribute. To modify an existing attribute, make sure the name of the attribute remains the same.
    
    Parameters:
    
    attrDef - the attribute definition to be added/modified
  - removeAttribute
```
public void removeAttribute(java.lang.String attrName)
```
    Remove an attribute. Note that removing an attribute will also remove its corresponding attribute mapping if one exist.
    
    Parameters:
    
    attrName - the attribute name to be removed
  - getFields
```
public java.util.Map getFields()
```
    Get all the target field definitions
    
    Returns:
    
    all the target field definitions
  - getField
```
public FieldDefinition getField(java.lang.String fieldName)
```
    Get a target field definition
    
    Parameters:
    
    fieldName - the target field name
    
    Returns:
    
    the target field definition
  - addField
```
public void addField(FieldDefinition fieldDef)
```
    Add or modify an target field. To modify an existing target field, make sure the name of the target field remains the same.
    
    Parameters:
    
    fieldDef - the target field definition to be added/modified
  - removeField
```
public void removeField(java.lang.String fieldName)
```
    Remove an target field. Note that removing an target field will also remove its corresponding attribute mapping if one exist.
    
    Parameters:
    
    fieldName - the target field name to be removed
  - getAttributeMap
```
public java.util.Map getAttributeMap()
```
    Get the attribute map
    
    Returns:
    
    the attribute map
  - setAttributeMap
```
public void setAttributeMap(java.util.Map attrMap)
```
    Set the attribute map
    
    Parameters:
    
    attrMap - attribute map
  - addAttributeMapping
```
public void addAttributeMapping(java.lang.String attrName,
                                java.lang.String fieldName)
                         throws oracle.iam.platform.entitymgr.UnknownAttributeException
```
    Add or modify an attribute mapping. To modify an existing attribute mapping, use the same attribute name of the existing attribute mapping with the new target field name.
    
    Parameters:
    
    attrName - the attribute name
    
    fieldName - the target field name
    
    Throws:
    
    oracle.iam.platform.entitymgr.UnknownAttributeException - if the attribute name and/or target field name is not defined
  - removeAttributeMapping
```
public void removeAttributeMapping(java.lang.String attrName)
```
    Remove an attribute mapping.
    
    Parameters:
    
    attrName - the attribute name
  - toDocument
```
public org.w3c.dom.Document toDocument()
                                throws javax.xml.parsers.ParserConfigurationException
```
    Convert the relation metadata object into a XML document
    
    Returns:
    
    the relation metadata object in XML
    
    Throws:
    
    javax.xml.parsers.ParserConfigurationException - if a DocumentBuilder cannot be created
  - generateXml
```
public org.w3c.dom.Document generateXml()
                                 throws java.lang.Exception
```
    Specified by:
    
    generateXml in interface oracle.iam.platform.utils.XmlObject
    
    Throws:
    
    java.lang.Exception
  - generateObject
```
public void generateObject(org.w3c.dom.Document doc)
```
    Specified by:
    
    generateObject in interface oracle.iam.platform.utils.XmlObject

Class RelationMetadata

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RelationMetadata

RelationMetadata

Method Detail

getRelationType

getRepositoryInstance

setRepositoryInstance

getProviderType

setProviderType

getProviderParameters

setProviderParameters

getEntityType1

setEntityType1

getAttributeName1

setAttributeName1

getAttributeNameInEntity1

setAttributeNameInEntity1

getAttributeGroupName1

setAttributeGroupName1

getEntityType2

setEntityType2

getAttributeName2

setAttributeName2

getAttributeNameInEntity2

setAttributeNameInEntity2

getAttributeGroupName2

setAttributeGroupName2

getAttributes

getAttribute

addAttribute

removeAttribute

getFields

getField

addField

removeField

getAttributeMap

setAttributeMap

addAttributeMapping

removeAttributeMapping

toDocument

generateXml

generateObject