JoinDirectiveInfo

java.lang.Object
- com.ibm.itim.dataservices.model.policy

All Implemented Interfaces:

java.io.Serializable
```
public class JoinDirectiveInfo
implements java.io.Serializable
```
This class represents a value object for carrying join directive info data between the webclient and the application server.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`PRIORITY` join type enumeration item
`static int`	`OR` join type enumeration item
`static int`	`AND` join type enumeration item
`static int`	`UNION` join type enumeration item
`static int`	`INTERSECTION` join type enumeration item
`static int`	`HIGHEST` join type enumeration item
`static int`	`LOWEST` join type enumeration item
`static int`	`AVERAGE` join type enumeration item
`static int`	`PRECEDENCE_SEQUENCE` join type enumeration item
`static int`	`BITWISE_OR` join type enumeration item
`static int`	`BITWISE_AND` join type enumeration item
`static int`	`APPEND` join type enumeration item
`static int`	`CUSTOM` join type enumeration item
`static java.lang.String`	`MULTIVALUED` Join types static map variable for MULTIVALUED attributes
`static java.lang.String`	`SINGLEVALUED_NUMERIC` join types static map variable for SINGLEVALUED_NUMERIC_STRING attributes
`static java.lang.String`	`SINGLEVALUED_NUMERIC_STRING` Join types static map variable for SINGLEVALUED_NUMERIC_STRING attributes
`static java.lang.String`	`SINGLEVALUED_STRING` Join types static map variable for SINGLEVALUED_STRING attributes
`static java.lang.String`	`SINGLEVALUED_BOOLEAN` Join types static map variable for SINGLEVALUED_BOOLEAN attributes
`static java.lang.String`	`SINGLEVALUED_BITSTRING` Join types static map variable for SINGLEVALUED_BITSTRING attributes
`static java.util.ArrayList`	`MULTIVALUED_JOIN_TYPES` List used to store allowable join types for SINGLEVALUED_NUMERIC attribute
`static java.util.ArrayList`	`SINGLEVALUED_JOIN_TYPES_NUMERIC` List used to store allowable join types for SINGLEVALUED_JOIN_TYPES_NUMERIC attribute
`static java.util.ArrayList`	`SINGLEVALUED_JOIN_TYPES_NUMERIC_STRING` List used to store allowable join types for SINGLEVALUED_JOIN_TYPES_NUMERIC_STRING attribute
`static java.util.ArrayList`	`SINGLEVALUED_JOIN_TYPES_STRING` List used to store allowable join types for SINGLEVALUED_JOIN_TYPES_STRING attribute
`static java.util.ArrayList`	`SINGLEVALUED_JOIN_TYPES_BOOLEAN` List used to store allowable join types for SINGLEVALUED_JOIN_TYPES_BOOLEAN attribute
`static java.util.ArrayList`	`SINGLEVALUED_JOIN_TYPES_BITSTRING` List used to store allowable join types for SINGLEVALUED_JOIN_TYPES_BITSTRING attribute
`static java.util.HashMap`	`ALLOWABLE_JOIN_TYPES` Map used to store allowable join types for ALLOWABLE_JOIN_TYPES attribute

Constructor Summary

Constructors
Constructor and Description
`JoinDirectiveInfo()` The default constructor.
`JoinDirectiveInfo(java.lang.String tenantDN,java.lang.String attributeName,java.lang.String attributeSyntax,java.lang.String attributeSchemaType,java.lang.String serviceProfileName,java.lang.String description,int directiveType,java.util.Collection precedenceSequence,java.lang.String customData)` The constructor accpeting all data arguments

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAttributeName()` Returns the ldap schema attribute name.
`java.lang.String`	`getAttributeSyntax()` Returns the attribute syntax oid.
`java.lang.String`	`getAttributeSchemaType()` Returns the attribute schema type.
`java.lang.String`	`getServiceProfileName()` Returns the service profile name for this instance.
`java.lang.String`	`getCustomData()` Returns the custom data for this instance.
`java.lang.String`	`getDescription()` Returns the description of join method defined in this instance.
`java.lang.String`	`getTenant()` Returns the tenant dn of the tenant to which this join directive belongs.
`java.lang.String`	`toString()` Returns the string representation of this object.
`DistinguishedName`	`getDN()` Return the current value of the dn property.
`java.util.Collection`	`getAllowableDirectiveTypes()` Returns the Collection of all allowable join types for the schema type.
`static java.util.Collection`	`getAllowableDirectiveTypes()` Returns the collection of allowable join directive types with the first.
`java.util.Collection`	`getAllowableDirectiveTypes()` Returns the Collection of all allowable join types for the schema type.
`int`	`getDirectiveType()` Returns the the directive type for this instance.
`void`	`setDN(DistinguishedName DN)` Sets the current value of the dn property.
`void`	`setDirectiveType(int directiveType)` Sets the directive type for this instance
`void`	`setPrecedenceSequence(java.util.Collection sequence)` Sets the precedence sequence for this instance.
`void`	`setCustomData(java.lang.String customData)` Sets the custom data for this instance

Methods inherited from class java.lang.Object
toString

- Field Detail
  - PRIORITY
```
public static final int PRIORITY
```
    The PRIORITY constant indicates a join directive that gives precedence to certain values.
    
    See Also:
    
    Constant Field Values
  - OR
```
public static final int OR
```
    The OR constant represents a join directive that combines multiple values or conditions.
    
    See Also:
    
    Constant Field Values
  - AND
```
public static final int AND
```
    The AND can be utilized when defining attribute joins in the context of LDAP schema attributes.
    
    See Also:
    
    Constant Field Values
  - UNION
```
public static final int UNION
```
    The UNION constant represents a join directive that combines the results of multiple sets of values or records, allowing for the inclusion of all unique records from each set.
    
    See Also:
    
    Constant Field Values
  - INTERSECTION
```
public static final int INTERSECTION
```
    The INTERSECTION constant represents a join directive that returns only the records or values that are common to multiple sets.
    
    See Also:
    
    Constant Field Values
  - HIGHEST
```
public static final int HIGHEST
```
    The HIGHEST constant represents a join directive that specifies the selection of the highest value from a set of comparable values.
    
    See Also:
    
    Constant Field Values
  - LOWEST
```
public static final int LOWEST
```
    The LOWEST constant represents a join directive that specifies the selection of the lowest value from a set of comparable values.
    
    See Also:
    
    Constant Field Values
  - AVERAGE
```
public static final int AVERAGE
```
    The AVERAGE constant represents a join directive that calculates the average value from a set of numeric values.
    
    See Also:
    
    Constant Field Values
  - PRECEDENCE_SEQUENCE
```
public static final int PRECEDENCE_SEQUENCE
```
    The PRECEDENCE_SEQUENCE constant represents a join directive that specifies an order of importance for a set of values
    
    See Also:
    
    Constant Field Values
  - PRECEDENCE_SEQUENCE
```
public static final int PRECEDENCE_SEQUENCE
```
    The PRECEDENCE_SEQUENCE constant represents a join directive that specifies an order of importance for a set of values
    
    See Also:
    
    Constant Field Values
  - BITWISE_OR
```
public static final int BITWISE_OR
```
    The BITWISE_OR constant represents a join directive that performs a bitwise OR operation on a set of bit values.
    
    See Also:
    
    Constant Field Values
  - BITWISE_AND
```
public static final int BITWISE_AND
```
    The BITWISE_AND constant represents a join directive that performs a bitwise AND operation on a set of bit values.
    
    See Also:
    
    Constant Field Values
  - APPEND
```
public static final int APPEND
```
    The APPEND constant is an integer value that represents a join directive used to concatenate multiple values into a single output.
    
    See Also:
    
    Constant Field Values
  - CUSTOM
```
public static final int CUSTOM
```
    The CUSTOM constant is an integer value that represents a join directive allowing for user-defined operations or custom behavior during the join process.
    
    See Also:
    
    Constant Field Values
  - MULTIVALUED
```
public static final java.lang.String MULTIVALUED
```
    The MULTIVALUED constant is a string that represents a schema type indicating that an attribute can hold multiple values.
    
    See Also:
    
    Constant Field Values
  - SINGLEVALUED_NUMERIC
```
public static final java.lang.String SINGLEVALUED_NUMERIC 
```
    The SINGLEVALUED_NUMERIC constant is a string that indicates an attribute schema type which can hold a single numeric value.
    
    See Also:
    
    Constant Field Values
  - SINGLEVALUED_NUMERIC_STRING
```
public static final java.lang.String SINGLEVALUED_NUMERIC_STRING
```
    The SINGLEVALUED_NUMERIC_STRING constant is a string that indicates an attribute schema type which can hold a single value represented as a numeric string. The SINGLEVALUED_NUMERIC_STRING constant is a string that indicates an attribute schema type which can hold a single value represented as a numeric string.
    
    See Also:
    
    Constant Field Values
  - SINGLEVALUED_STRING
```
public static final java.lang.String SINGLEVALUED_STRING
```
    The SINGLEVALUED_STRING constant is a string that indicates an attribute schema type which can hold a single string value.
    
    See Also:
    
    Constant Field Values
  - SINGLEVALUED_BOOLEAN
```
public static final java.lang.String SINGLEVALUED_BOOLEAN
```
    The SINGLEVALUED_BOOLEAN constant is a string that indicates an attribute schema type which can hold a single boolean value.
    
    See Also:
    
    Constant Field Values
  - SINGLEVALUED_BITSTRING
```
public static final java.lang.String SINGLEVALUED_BITSTRING
```
    The SINGLEVALUED_BITSTRING constant is a string that indicates an attribute schema type which can hold a single bitstring value.
    
    See Also:
    
    Constant Field Values
  - Static Block Detail
    - ```
    MULTIVALUED_JOIN_TYPES = new ArrayList()
```
  MULTIVALUED_JOIN_TYPES.add(new Integer(UNION))
  
  MULTIVALUED_JOIN_TYPES.add(new Integer(INTERSECTION))
  
  MULTIVALUED_JOIN_TYPES.add(new Integer(CUSTOM))
  
  MULTIVALUED_JOIN_TYPES.add(new Integer(PRIORITY))
```
    SINGLEVALUED_JOIN_TYPES_NUMERIC = new ArrayList()
```
  SINGLEVALUED_JOIN_TYPES_NUMERIC.add(new Integer(HIGHEST))
  
  SINGLEVALUED_JOIN_TYPES_NUMERIC.add(new Integer(LOWEST))
  
  SINGLEVALUED_JOIN_TYPES_NUMERIC.add(new Integer(AVERAGE))
  
  SINGLEVALUED_JOIN_TYPES_NUMERIC.add(new Integer(CUSTOM))
  
  SINGLEVALUED_JOIN_TYPES_NUMERIC.add(new Integer(PRIORITY))
  
  SINGLEVALUED_JOIN_TYPES_NUMERIC.add(new Integer(PRECEDENCE_SEQUENCE))
```
    SINGLEVALUED_JOIN_TYPES_NUMERIC_STRING = new ArrayList()
```
  SINGLEVALUED_JOIN_TYPES_NUMERIC_STRING.add(new Integer(HIGHEST))
  
  SINGLEVALUED_JOIN_TYPES_NUMERIC_STRING.add(new Integer(LOWEST))
  
  SINGLEVALUED_JOIN_TYPES_NUMERIC_STRING.add(new Integer(AVERAGE))
  
  SINGLEVALUED_JOIN_TYPES_NUMERIC_STRING.add(new Integer(CUSTOM))
  
  SINGLEVALUED_JOIN_TYPES_NUMERIC_STRING.add(new Integer(PRIORITY))
  
  SINGLEVALUED_JOIN_TYPES_NUMERIC_STRING.add(new Integer(PRECEDENCE_SEQUENCE))
```
    SINGLEVALUED_JOIN_TYPES_STRING = new ArrayList()
```
  SINGLEVALUED_JOIN_TYPES_STRING.add(new Integer(PRIORITY))
  
  SINGLEVALUED_JOIN_TYPES_STRING.add(new Integer(OR))
  
  SINGLEVALUED_JOIN_TYPES_STRING.add(new Integer(AND))
  
  SINGLEVALUED_JOIN_TYPES_STRING.add(new Integer(BITWISE_OR))
  
  SINGLEVALUED_JOIN_TYPES_STRING.add(new Integer(BITWISE_AND))
  
  SINGLEVALUED_JOIN_TYPES_STRING.add(new Integer(HIGHEST))
  
  SINGLEVALUED_JOIN_TYPES_STRING.add(new Integer(LOWEST))
  
  SINGLEVALUED_JOIN_TYPES_STRING.add(new Integer(AVERAGE))
  
  SINGLEVALUED_JOIN_TYPES_STRING.add(new Integer(PRECEDENCE_SEQUENCE))
  
  SINGLEVALUED_JOIN_TYPES_STRING.add(new Integer(APPEND))
  
  SINGLEVALUED_JOIN_TYPES_STRING.add(new Integer(CUSTOM))
```
    SINGLEVALUED_JOIN_TYPES_BOOLEAN = new ArrayList()
```
  SINGLEVALUED_JOIN_TYPES_BOOLEAN.add(new Integer(OR))
  
  SINGLEVALUED_JOIN_TYPES_BOOLEAN.add(new Integer(AND))
  
  SINGLEVALUED_JOIN_TYPES_BOOLEAN.add(new Integer(CUSTOM))
  
  SINGLEVALUED_JOIN_TYPES_BOOLEAN.add(new Integer(PRIORITY))
```
    SINGLEVALUED_JOIN_TYPES_BITSTRING = new ArrayList()
```
  SINGLEVALUED_JOIN_TYPES_BITSTRING.add(new Integer(BITWISE_OR))
  
  SINGLEVALUED_JOIN_TYPES_BITSTRING.add(new Integer(BITWISE_AND))
  
  SINGLEVALUED_JOIN_TYPES_BITSTRING.add(new Integer(CUSTOM))
  
  SINGLEVALUED_JOIN_TYPES_BITSTRING.add(new Integer(PRIORITY))
```
    ALLOWABLE_JOIN_TYPES = new HashMap()
```
  ALLOWABLE_JOIN_TYPES.put(MULTIVALUED, MULTIVALUED_JOIN_TYPES)
  
  ALLOWABLE_JOIN_TYPES.put(SINGLEVALUED_NUMERIC, SINGLEVALUED_JOIN_TYPES_NUMERIC)
  
  ALLOWABLE_JOIN_TYPES.put(SINGLEVALUED_NUMERIC_STRING, SINGLEVALUED_JOIN_TYPES_NUMERIC_STRING)
  
  ALLOWABLE_JOIN_TYPES.put(SINGLEVALUED_STRING, SINGLEVALUED_JOIN_TYPES_STRING)
  
  ALLOWABLE_JOIN_TYPES.put(SINGLEVALUED_BOOLEAN, SINGLEVALUED_JOIN_TYPES_BOOLEAN)
  
  ALLOWABLE_JOIN_TYPES.put(SINGLEVALUED_BITSTRING, SINGLEVALUED_JOIN_TYPES_BITSTRING)
  
  Purpose of Each Collection
  
  MULTIVALUED_JOIN_TYPES: Contains join types applicable to multivalued attributes.
  
  SINGLEVALUED_JOIN_TYPES_NUMERIC: Holds join types for single-valued numeric attributes.
  
  SINGLEVALUED_JOIN_TYPES_NUMERIC_STRING: Holds join types for single-valued numeric string attributes.
  
  SINGLEVALUED_JOIN_TYPES_STRING: Contains join types for single-valued string attributes.
  
  SINGLEVALUED_JOIN_TYPES_BOOLEAN: Contains join types for single-valued boolean attributes.
  
  SINGLEVALUED_JOIN_TYPES_BITSTRING: Contains join types for single-valued bitstring attributes.
  
  ALLOWABLE_JOIN_TYPES: A mapping of attribute schema types to their corresponding allowable join types.
- Constructor Detail
  - JoinDirectiveInfo
    
    public JoinDirectiveInfo()
    
    The default constructor.
  - JoinDirectiveInfo
    
    public JoinDirectiveInfo(java.lang.String tenantDN,java.lang.String attributeName,java.lang.String attributeSyntax,java.lang.String attributeSchemaType,java.lang.String serviceProfileName,java.lang.String description,int directiveType,java.util.Collection precedenceSequence,java.lang.String customData)
    
    The JoinDirectiveInfo constructor with full set of parameters. This constructor is prefered for a complete JoinDirective.
    
    Parameters:
    
    tenantDN - The distinguished name (DN) of the tenant to which this join directive belongs.
    
    attributeName - The LDAP schema attribute name that this join directive is associated with
    
    attributeSyntax - The Object Identifier (OID) of the attribute syntax.
    
    attributeSchemaType - The schema type of the attribute, such as MULTIVALUED, SINGLEVALUED_NUMERIC, etc.
    
    serviceProfileName - The name of the service profile associated with this directive.
    
    description - A textual description providing rationale or additional context for using this join directive, particularly if it deviates from defaults.
    
    directiveType - An integer representing the type of join directive, defined by constants like PRIORITY, OR, AND, etc
    
    precedenceSequence - A collection representing the order of importance of allowable values for join types that accept sequences.
    
    customData - Custom data that can be used to specify a Java class name, JavaScript code, or XML with special processing rules, allowing for tailored behavior in join operations.
- Method Detail
  - toString
    
    public java.lang.String toString()
    
    The toString method overrides the default toString method provided by the Object class. It constructs a string representation of the JoinDirectiveInfo object, summarizing its fields and their current values.
    
    Returns:
    
    Returns a formatted string that includes the values of the key fields in the JoinDirectiveInfo object.
  - setDN
    
    public void setDN(DistinguishedName DN)
    
    This method allows the user to assign a DistinguishedName object to the dn attribute of the instance, updating the object's state.
    
    Parameters:
    
    DN - A DN object that represents the distinguished name to be set for this instance.
  - setDirectiveType
    
    public void setDirectiveType(int directiveType)
    
    This method allows the caller to set or update the value of the directiveType attribute, which defines the type of join directive to be used.
    
    Parameters:
    
    directiveType - This directiveType determines the specific behavior of the join operation associated with this instance
  - setPrecedenceSequence
    
    public void setPrecedenceSequence(java.util.Collection sequence)
    
    This method allows the caller to set or update the collection of values that represent the order of importance for the allowable values associated with the join directive.
    
    Parameters:
    
    sequence - A collection of values that defines the precedence order for the join directive
  - setCustomData
    
    public void setCustomData(java.lang.String customData)
    
    This method allows the caller to set or update the value of the customData attribute, which can include additional instructions or information relevant to custom join types.
    
    Parameters:
    
    customData - A string representing the custom data to be associated with the join directive.
  - setDescription
    
    public void setDescription(java.lang.String description)
    
    This method allows the caller to set or update the value of the description attribute, which provides a rationale or explanation for using a specific join directive.
    
    Parameters:
    
    description - A string containing the new description for the join directive.
  - getDN
    
    public DistinguishedName getDN()
    
    This method retrieves the current value of the dn attribute, which represents the distinguished name associated with the join directive.
    
    Returns:
    
    DistinguishedName object that represents the distinguished name for this instance.
  - getAttributeName
    
    public java.lang.String getAttributeName()
    
    This method retrieves the current value of the attributeName attribute, which specifies the LDAP schema attribute associated with the join directive.
    
    Returns:
    
    Returns the attribute name of the LDAP schema attribute as a string.
  - getAttributeSyntax
    
    public java.lang.String getAttributeSyntax()
    
    This method retrieves the current value of the attributeSyntax attribute, which specifies the Object Identifier (OID) of the attribute's syntax.
    
    Returns:
    
    Returns the OID of the attribute syntax as a string
  - getAttributeSchemaType
    
    public java.lang.String getAttributeSchemaType()
    
    This method retrieves the current value of the attributeSchemaType attribute, which specifies the type of the attribute according to its schema.
    
    Returns:
    
    Returns the schema type of the attribute as a string.
  - getServiceProfileName
    
    public java.lang.String getServiceProfileName()
    
    This method retrieves the current value of the attributeName attribute, which specifies the LDAP schema attribute associated with the join directive.
    
    Returns:
    
    Returns the name of the service profile as a string.
  - getCustomData
    
    public java.lang.String getCustomData()
    
    This method retrieves the current value of the customData attribute, which can contain additional information or instructions relevant to custom join types..
    
    Returns:
    
    Returns the custom data associated with the join directive as a string
  - getDescription
    
    public java.lang.String getDescription()
    
    This method retrieves the current value of the description attribute, which provides an explanation or rationale behind using a specific join directive.
    
    Returns:
    
    Returns the description associated with the join directive as a string.
  - getTenant
    
    public java.lang.String getTenant()
    
    This method retrieves the current value of the tenantDN attribute, which specifies the distinguished name of the tenant to which the join directive belongs.
    
    Returns:
    
    Returns the distinguished name of the tenant as a string.
  - getDirectiveType
    
    public int getDirectiveType()
    
    Gets the directive type for this instance.
    
    Returns:
    
    int containing one of the static values
  - getAllowableDirectiveTypes
    
    public java.util.Collection getAllowableDirectiveTypes()
    
    This method retrieves the list of join types that are permissible for the given attribute schema type associated with the instance of JoinDirectiveInfo.
    
    Returns:
    
    It return collection will contain the allowable directive types (as defined in the class) for the attribute schema type set in this instance
  - getPrecedenceSequence
    
    public java.util.Collection getPrecedenceSequence()
    
    This method returns the precedenceSequence attribute, which contains a collection of values that determine the order of importance for the join values that may be applied in the context of this directive.
    
    Returns:
    
    The method returns a Collection. This could be a list, set, or any other type of collection that holds the values representing the precedence sequence.
  - getAllowableDirectiveTypes(java.lang.String)
    
    public java.util.Collection getAllowableDirectiveTypes(java.lang.String attributeSchemaType)
    
    This method provides a way to obtain the allowable directive types for a given attribute schema type without needing to create an instance of the JoinDirectiveInfo class. This is particularly useful for determining valid join types based on the schema type.
    
    Returns:
    
    The method returns a Collection containing the allowable join directive types associated with the specified attributeSchemaType. If the provided type does not exist in the map, it will return null

Methods inherited from class java.lang.Object

PRIORITY

OR

AND

UNION

INTERSECTION

HIGHEST

LOWEST

AVERAGE

PRECEDENCE_SEQUENCE

PRECEDENCE_SEQUENCE

BITWISE_OR

BITWISE_AND

APPEND

CUSTOM

MULTIVALUED

SINGLEVALUED_NUMERIC

SINGLEVALUED_NUMERIC_STRING

SINGLEVALUED_STRING

SINGLEVALUED_BOOLEAN

SINGLEVALUED_BITSTRING

Static Block Detail

Purpose of Each Collection

Constructor Detail

JoinDirectiveInfo

JoinDirectiveInfo

Method Detail

toString

setDN

setDirectiveType

setPrecedenceSequence

setCustomData

setDescription

getDN

getAttributeName

getAttributeSyntax

getAttributeSchemaType

getServiceProfileName

getCustomData

getDescription

getTenant

getDirectiveType

getAllowableDirectiveTypes

getPrecedenceSequence

getAllowableDirectiveTypes(java.lang.String)