org.openliberty.arisidbeans
Class IGFObjectManager

java.lang.Object
  org.openliberty.arisidbeans.IGFObjectManager

public abstract class IGFObjectManager
extends java.lang.Object

IGFObjectManager is an abstract class containing methods that are generic to any CARML declaration and this class is inherited by the BeanManager class generated from a CARML file.

Field Summary

static java.lang.String	APP_CTX_AUTHUSER Deprecated. This will be removed in the future. Use ArisIdConstants.APP_CTX_AUTHUSER instead
static java.lang.String	APP_CTX_LOCALE Deprecated. This will be removed in the future. Use ArisIdConstants.APP_CTX_LOCALE instead
static java.lang.String	APP_CTX_PAGE Deprecated. This will be removed in the future. Use ArisIdConstants.APP_CTX_PAGESIZE instead
static java.lang.String	LOG_LEVEL Deprecated. This will be removed in the future.
static java.lang.String	LOGGER_NAME Deprecated. This will be removed in the future.
static java.lang.String	SECURITY_CREDENTIALS Deprecated. This will be removed in the future. Use ArisIdConstants.SECURITY_CREDENTIALS instead
static java.lang.String	SECURITY_PRINCIPAL Deprecated. This will be removed in the future. Use ArisIdConstants.SECURITY_PRINCIPAL instead

Constructor Summary

IGFObjectManager()

Method Summary

void	dispose() Releases the ArisId service handle
void	finalize()
java.util.List<java.lang.String>	getAllAttributeNames() Gets list of all attributes' names referred in all CARML interactions
java.util.List<java.lang.String>	getAllAttributeNames(java.lang.String interactionName) Gets list of all attributes' name referred in a given interaction
java.util.List<java.lang.String>	getAllInteractions() Gets all interaction names in the CARML file
java.util.List<java.lang.String>	getAllInteractions(java.lang.String interactionType) Gets list of all interaction names in a CARML file for requested interaction Type
java.util.List<java.lang.String>	getAllPredicateNames() Gets list of all predicates' names referred in all CARML interactions
java.util.List<java.lang.String>	getAllPredicateNames(java.lang.String interactionName) Gets list of all predicates' name referred in a given interaction
java.util.List<java.lang.String>	getAllPropertyNames() Gets list of all properties' (attributes, predicates and roles) names referred in all CARML interactions
java.util.List<java.lang.String>	getAllPropertyNames(java.lang.String interactionName) Gets list of all properties' (attributes, predicates and roles) names referred in a given interaction
java.util.List<java.lang.String>	getAllRoles() Gets list of all roles referred in all CARML interactions
java.util.List<java.lang.String>	getAllRoles(java.lang.String interactionName) Gets list of all roles referred in a given interaction
AttributeDef	getAttributeDef(java.lang.String attributeName) Gets the Attribute Definition as specified in the CARML declaration file
PredicateDef	getPredicateDef(java.lang.String predicateName) Gets the Predicate Definition as specified in the CARML declaration file
RoleDef	getRoleDef(java.lang.String roleName) Gets the Role Definition as specified in the CARML declaration file
boolean	isAttribute(java.lang.String name) Return TRUE if the given property name is an Attribute
boolean	isPredicate(java.lang.String name) Return TRUE if the given property name is a Predicate
boolean	isRole(java.lang.String name) Return TRUE if the given property name is a Role

Methods inherited from class java.lang.Object

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

Field Detail

APP_CTX_AUTHUSER

public static final java.lang.String APP_CTX_AUTHUSER

Deprecated. This will be removed in the future. Use ArisIdConstants.APP_CTX_AUTHUSER instead

See Also:

Constant Field Values

APP_CTX_PAGE

public static final java.lang.String APP_CTX_PAGE

Deprecated. This will be removed in the future. Use ArisIdConstants.APP_CTX_PAGESIZE instead

See Also:

Constant Field Values

APP_CTX_LOCALE

public static final java.lang.String APP_CTX_LOCALE

Deprecated. This will be removed in the future. Use ArisIdConstants.APP_CTX_LOCALE instead

See Also:

Constant Field Values

SECURITY_PRINCIPAL

public static final java.lang.String SECURITY_PRINCIPAL

Deprecated. This will be removed in the future. Use ArisIdConstants.SECURITY_PRINCIPAL instead

See Also:

Constant Field Values

SECURITY_CREDENTIALS

public static final java.lang.String SECURITY_CREDENTIALS

Deprecated. This will be removed in the future. Use ArisIdConstants.SECURITY_CREDENTIALS instead

See Also:

Constant Field Values

LOGGER_NAME

public static final java.lang.String LOGGER_NAME

Deprecated. This will be removed in the future.

See Also:

Constant Field Values

LOG_LEVEL

public static final java.lang.String LOG_LEVEL

Deprecated. This will be removed in the future.

See Also:

Constant Field Values

Constructor Detail

IGFObjectManager

public IGFObjectManager()

Method Detail

isAttribute

public boolean isAttribute(java.lang.String name)

Return TRUE if the given property name is an Attribute

Parameters:

name - property name

Returns:

true if the property is an Attribute, otherwise return false

isPredicate

public boolean isPredicate(java.lang.String name)

Return TRUE if the given property name is a Predicate

Parameters:

name - property name

Returns:

true if the property is a Predicate, otherwise return false

isRole

public boolean isRole(java.lang.String name)

Return TRUE if the given property name is a Role

Parameters:

name - property name

Returns:

true if the property is a Role, otherwise return false

getAttributeDef

public AttributeDef getAttributeDef(java.lang.String attributeName)

Gets the Attribute Definition as specified in the CARML declaration file

Parameters:

attributeName - Name of the attribute for which the Attribute Definition to be returned

Returns:

Attribue Definition

getPredicateDef

public PredicateDef getPredicateDef(java.lang.String predicateName)

Gets the Predicate Definition as specified in the CARML declaration file

Parameters:

predicateName - Name of the predicate for which the Predicate Definition to be returned

Returns:

Predicate Definition

getRoleDef

public RoleDef getRoleDef(java.lang.String roleName)

Gets the Role Definition as specified in the CARML declaration file

Parameters:

roleName - Name of the role for which the Role Definition to be returned

Returns:

Role Definition

getAllAttributeNames

public java.util.List<java.lang.String> getAllAttributeNames()

Gets list of all attributes' names referred in all CARML interactions

Returns:

list of attribute names

getAllAttributeNames

public java.util.List<java.lang.String> getAllAttributeNames(java.lang.String interactionName)

Gets list of all attributes' name referred in a given interaction

Parameters:

interactionName - Interaction in the CARML file

Returns:

list of attribute names

getAllPredicateNames

public java.util.List<java.lang.String> getAllPredicateNames()

Gets list of all predicates' names referred in all CARML interactions

Returns:

list of predicate names

getAllPredicateNames

public java.util.List<java.lang.String> getAllPredicateNames(java.lang.String interactionName)

Gets list of all predicates' name referred in a given interaction

Parameters:

interactionName - Interaction in the CARML file

Returns:

list of predicate names

getAllRoles

public java.util.List<java.lang.String> getAllRoles()

Gets list of all roles referred in all CARML interactions

Returns:

list of roles

getAllRoles

public java.util.List<java.lang.String> getAllRoles(java.lang.String interactionName)

Gets list of all roles referred in a given interaction

Parameters:

interactionName - Interaction in the CARML file

Returns:

list of roles

getAllPropertyNames

public java.util.List<java.lang.String> getAllPropertyNames()

Gets list of all properties' (attributes, predicates and roles) names referred in all CARML interactions

Returns:

list of property names

getAllPropertyNames

public java.util.List<java.lang.String> getAllPropertyNames(java.lang.String interactionName)

Gets list of all properties' (attributes, predicates and roles) names referred in a given interaction

Parameters:

interactionName - Interaction in the CARML file

Returns:

list of property names

getAllInteractions

public java.util.List<java.lang.String> getAllInteractions()

Gets all interaction names in the CARML file

Returns:

list of interaction names

getAllInteractions

public java.util.List<java.lang.String> getAllInteractions(java.lang.String interactionType)

Gets list of all interaction names in a CARML file for requested interaction Type

Parameters:

interactionType - Interaction Type (READ, FIND, SEARCH, COMPARE, ADD, MODIFY or DELETE)

Returns:

list of interaction names

dispose

public void dispose()

Releases the ArisId service handle

finalize

public void finalize()
              throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable