openconnector

Class Schema.Attribute

java.lang.Object

openconnector.Schema.Attribute

Enclosing class:

Schema

public static class Schema.Attribute
extends java.lang.Object

The definition of a resource object attribute.

Constructor Summary

Constructors

Constructor and Description
Attribute() Create an empty attribute.
Attribute(java.lang.String name) Create a STRING attribute with the given name.
Attribute(java.lang.String name, Schema.Type type) Create a single-valued attribute with the given name and type.
Attribute(java.lang.String name, Schema.Type type, boolean multi) Create a multi-valued attribute with the given name and type.
Attribute(java.lang.String name, Schema.Type type, java.lang.Integer size) Create a single-valued attribute with the given name, type, and size.
Attribute(java.lang.String name, Schema.Type type, java.lang.Integer size, boolean multi) Create an attribute with the given properties.
Attribute(java.lang.String name, Schema.Type type, java.lang.Integer size, boolean multi, java.lang.String schemaObjectType) Create an attribute with give properties
Attribute(java.lang.String name, Schema.Type type, java.lang.Integer size, boolean multi, java.lang.String schemaObjectType, java.lang.String description) Create an attribute with given properties

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Get long description of attribute
java.lang.String	getName() Return the name of the attribute.
java.lang.String	getObjectType()
java.lang.String	getSchemaObjectType()
java.lang.Integer	getSize() Return the size of the attribute (for example - length) if pertinent, or null otherwise.
Schema.Type	getType() Return the type of the attribute.
boolean	isEntitlement() A flag to indicate if an attribute is an entitlement.
boolean	isManaged() Returns a boolean indicating that the attribute is managed.
boolean	isMulti() Return whether this attribute is multi-valued.
void	setDescription(java.lang.String description) Sets description of attribute
void	setEntitlement(boolean entitlement) Sets the is entitlement flag.
void	setManaged(boolean managed) Sets the is entitlement flag.
void	setMulti(boolean b)
void	setName(java.lang.String s) Set the name of the attribute.
void	setObjectType(java.lang.String s) Set the schema name of the objects referenced by this attribute.
void	setSchemaObjectType(java.lang.String schemaObjectType) Set schemaObjectType of attribute
void	setSize(java.lang.Integer i) Set the size of the attribute.
void	setType(Schema.Type t) Set the type of the attribute.

Methods inherited from class java.lang.Object

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

Constructor Detail

Attribute

public Attribute()

Create an empty attribute.

Attribute

public Attribute(java.lang.String name)

Create a STRING attribute with the given name.

Attribute

public Attribute(java.lang.String name,
                 Schema.Type type)

Create a single-valued attribute with the given name and type.

Attribute

public Attribute(java.lang.String name,
                 Schema.Type type,
                 boolean multi)

Create a multi-valued attribute with the given name and type.

Attribute

public Attribute(java.lang.String name,
                 Schema.Type type,
                 java.lang.Integer size)

Create a single-valued attribute with the given name, type, and size.

Attribute

public Attribute(java.lang.String name,
                 Schema.Type type,
                 java.lang.Integer size,
                 boolean multi)

Create an attribute with the given properties.

Attribute

public Attribute(java.lang.String name,
                 Schema.Type type,
                 java.lang.Integer size,
                 boolean multi,
                 java.lang.String schemaObjectType)

Create an attribute with give properties

Parameters:

name - of attribute

type - Type of attribute

size - of attribute

multi - boolean flag to indicate whether is multi-valued or not

schemaObjectType - is used in case of multi-group schema

Attribute

public Attribute(java.lang.String name,
                 Schema.Type type,
                 java.lang.Integer size,
                 boolean multi,
                 java.lang.String schemaObjectType,
                 java.lang.String description)

Create an attribute with given properties

Parameters:

name - of attribute

type - Type of attribute

size - of attribute

multi - boolean flag to indicate whether is multi-valued or not

schemaObjectType - is used in case of multi-group schema

description - Optional long description for the attribute.

Method Detail

getName

public java.lang.String getName()

Return the name of the attribute.

setName

public void setName(java.lang.String s)

Set the name of the attribute.

getType

public Schema.Type getType()

Return the type of the attribute.

setType

public void setType(Schema.Type t)

Set the type of the attribute.

getSize

public java.lang.Integer getSize()

Return the size of the attribute (for example - length) if pertinent, or null otherwise.

setSize

public void setSize(java.lang.Integer i)

Set the size of the attribute.

isMulti

public boolean isMulti()

Return whether this attribute is multi-valued.

setMulti

public void setMulti(boolean b)

getObjectType

public java.lang.String getObjectType()

Returns:

the schema name of objects referenced by this attribute. Currently used only for groups.

setObjectType

public void setObjectType(java.lang.String s)

Set the schema name of the objects referenced by this attribute.

getSchemaObjectType

public java.lang.String getSchemaObjectType()

Returns:

schemaObjectType of attribute which is used in multi-group schema

setSchemaObjectType

public void setSchemaObjectType(java.lang.String schemaObjectType)

Set schemaObjectType of attribute

isManaged

public boolean isManaged()

Returns a boolean indicating that the attribute is managed.

setManaged

public void setManaged(boolean managed)

Sets the is entitlement flag.

isEntitlement

public boolean isEntitlement()

A flag to indicate if an attribute is an entitlement. This is used to determine which attributes should be treated as additional entitlements during entitlement correlation, and should be included when prototype objects are created.

setEntitlement

public void setEntitlement(boolean entitlement)

Sets the is entitlement flag.

getDescription

public java.lang.String getDescription()

Get long description of attribute

Returns:

long description of attribute

setDescription

public void setDescription(java.lang.String description)

Sets description of attribute