public class ApplicationInstance
extends java.lang.Object
implements java.io.Serializable
ApplicationInstance
.
This is a combination of the IT Resource Instance (target connectivity + connector configuration)
and the Resource Object (the provisioning mechanism).
An Application Instance will have a well-known business friendly name and additional metadata associated with it.
An Application Instance is the provision able entity which will be published to the catalog.
The Application Instance is also the entity with which security primitives are associated
via the organization publishing mechanism.
In multi-tenant environments, resource definitions can be shared by multiple organizations,
but only those organizations that have the application instance published to them will be actually able to provision
to the targetsModifier and Type | Class and Description |
---|---|
static class |
ApplicationInstance.TYPE
An enumeration which determines the type of this Application Instance.
|
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
APP_INSTANCE_PARENT_KEY |
static java.lang.String |
APPINST_KEY |
static java.lang.String |
APPINST_NAME |
static java.lang.String |
APPINST_TYPE |
static java.lang.String |
APPLICATION_TYPE |
static java.lang.String |
ASSIGNED_PARENT_APP_INSTANCE |
static java.lang.String |
DATASET |
static java.lang.String |
DESCRIPTION |
static java.lang.String |
DISPLAY_NAME |
static java.lang.String |
ENDROW |
static java.lang.String |
FORMDETAILS |
static java.lang.String |
ITRES_KEY |
static java.lang.String |
ITRES_NAME |
static java.lang.String |
OBJ_DISCONNECTED |
static java.lang.String |
OBJ_KEY |
static java.lang.String |
OBJ_NAME |
static java.lang.String |
OPERATIONCONTEXT |
static long |
serialVersionUID |
static java.lang.String |
SORTEDBY |
static java.lang.String |
SORTORDER |
static java.lang.String |
STARTROW |
Constructor and Description |
---|
ApplicationInstance() |
ApplicationInstance(long appInstanceKey)
This constructor creates an instance of ApplicationInstance that is already
been created.
|
ApplicationInstance(java.lang.String applicationInstanceName,
java.lang.String displayName,
java.lang.String description,
long objectKey,
long itResourceKey,
java.lang.String dataSetName,
java.lang.String uiFragmentName)
This constructor is used to create (add) an ApplicationInstance record in OIM respository.
|
Modifier and Type | Method and Description |
---|---|
void |
addChildForm(FormInfo childForm) |
FormInfo |
getAccountForm()
This method returns FormInfo value object containing meta data information about
parent form and child form associated with ApplicationInstance
|
long |
getApplicationInstanceKey()
This method is used to get primary key of ApplicationInstance (APP_INSTANCE.APP_INSTANCE_KEY)
|
java.lang.String |
getApplicationInstanceName()
This method is used to get ApplicationInstance name (APP_INSTANCE.APP_INSTANCE_NAME)
|
Catalog |
getCatalogAttributes()
This method gets the catalog values
|
java.util.List |
getChildForms()
This method returns the list of FormInfo value object containing meta data information about
child form associated with ApplicationInstance
|
java.lang.String |
getDataSetName()
This method is used to get the dataset Name (APP_INSTANCE.APP_INSTANCE_DATASET)
associated with ApplicationInstance.
|
java.lang.String |
getDescription()
This method is used to get the description associated with ApplicationInstance.
|
java.lang.String |
getDisplayName()
This method gets the display name of the ApplicationInstance (APP_INSTANCE.APP_INSTANCE_DISPLAY_NAME)
|
long |
getItResourceKey()
This method is used to get the ITResource key (APP_INSTANCE.ITRESOURCE_KEY)
associated with ApplicationInstance.
|
java.lang.String |
getItResourceName()
This method is used to get the ITResource name (SVR.SVR_NAME) for
ITResource associated with ApplicationInstance.
|
long |
getObjectKey()
This method is used to get the Resource Object Key (APP_INSTANCE.OBJECT_KEY) associated with ApplicationInstance.
|
java.lang.String |
getObjectName()
This method is used to get the Resource Object Name (APP_INSTANCE.OBJECT_NAME)
associated with ApplicationInstance.
|
ApplicationInstance |
getParentAppInstance()
This method gets the parent ApplicationInstance associated with current ApplicationInstance.
|
long |
getParentKey()
This method gets the primary Key of the parent ApplicationInstance.
|
ApplicationInstance.TYPE |
getType()
This method is used to get type of ApplicationInstance.
|
boolean |
isApplicableToEntitlement()
Deprecated.
|
boolean |
isSoftDelete()
This method returns if ApplicationInstance is soft deleted.
|
void |
setAccountForm(FormInfo accountForm)
This method sets FormInfo value object containing meta data information about
parent form associated with ApplicationInstance
|
void |
setApplicableToEntitlement(boolean isApplicableToEntitlement)
Deprecated.
|
void |
setApplicationInstanceKey(long applicationInstanceKey)
This method is used to set ApplicationInstance primary key.
|
void |
setApplicationInstanceName(java.lang.String applicationInstanceName)
This method is used to set ApplicationInstance name (APP_INSTANCE.APP_INSTANCE_NAME)
|
void |
setCatalogAttributes(Catalog catalogAttributes)
This method sets the catalog values to the Application Instance object
|
void |
setChildForms(java.util.List childForms)
This method sets the list of FormInfo value object containing meta data information about
child form associated with ApplicationInstance
|
void |
setDataSetName(java.lang.String dataSetName)
This method is used to set the dataset Name (APP_INSTANCE.APP_INSTANCE_DATASET)
associated with ApplicationInstance.
|
void |
setDescription(java.lang.String description)
This method is used to set the description associated with ApplicationInstance.
|
void |
setDisplayName(java.lang.String displayName)
This method sets the display name of the ApplicationInstance (APP_INSTANCE.APP_INSTANCE_DISPLAY_NAME)
|
void |
setItResourceKey(long itResourceKey)
This method is used to set the ITResource key (APP_INSTANCE.ITRESOURCE_KEY)
associated with ApplicationInstance.
|
void |
setItResourceName(java.lang.String itResourceName)
This method is used to set the ITResource name (SVR.SVR_NAME) for
ITResource associated with ApplicationInstance.
|
void |
setObjectKey(long objectKey)
This method is used to set the Resource Object Key (APP_INSTANCE.OBJECT_KEY) associated with ApplicationInstance.
|
void |
setObjectName(java.lang.String objectName)
This method is used to set the Resource Object Name (APP_INSTANCE.OBJECT_NAME)
associated with ApplicationInstance.
|
void |
setParentAppInstance(ApplicationInstance parentAppInstance)
This method sets the parent ApplicationInstance associated with current ApplicationInstance.
|
void |
setParentKey(long parentKey)
This method sets the primary Key of the parent ApplicationInstance.
|
void |
setSoftDelete(boolean softDelete)
This method sets if ApplicationInstance is soft deleted.
|
void |
setType(ApplicationInstance.TYPE type)
This method is used to set type of ApplicationInstance.
|
java.lang.String |
toString()
This method is used to convert ApplicationInstance value object to String
It prints ApplicationInstance name:ITResourceKey:ResourceObjectKey
|
public static final long serialVersionUID
public static final java.lang.String APPINST_NAME
public static final java.lang.String OBJ_NAME
public static final java.lang.String ITRES_NAME
public static final java.lang.String DISPLAY_NAME
public static final java.lang.String APPINST_TYPE
public static final java.lang.String DESCRIPTION
public static final java.lang.String DATASET
public static final java.lang.String APPINST_KEY
public static final java.lang.String ITRES_KEY
public static final java.lang.String APPLICATION_TYPE
public static final java.lang.String OBJ_KEY
public static final java.lang.String APP_INSTANCE_PARENT_KEY
public static final java.lang.String STARTROW
public static final java.lang.String ENDROW
public static final java.lang.String SORTORDER
public static final java.lang.String SORTEDBY
public static final java.lang.String FORMDETAILS
public static final java.lang.String OPERATIONCONTEXT
public static final java.lang.String ASSIGNED_PARENT_APP_INSTANCE
public static final java.lang.String OBJ_DISCONNECTED
public ApplicationInstance(long appInstanceKey)
appInstanceKey
- The primary key of ApplicationInstance record in APP_INSTANCE table.public ApplicationInstance()
public ApplicationInstance(java.lang.String applicationInstanceName, java.lang.String displayName, java.lang.String description, long objectKey, long itResourceKey, java.lang.String dataSetName, java.lang.String uiFragmentName)
applicationInstanceName
- ApplicationInstance name.
One can not change ApplicationInstance name once it is created.displayName
- ApplicationInstance display name.description
- ApplicationInstance description.objectKey
- A Resource Object key (APP_INSTANCE.OBJECT_KEY) associated with ApplicationInstance.
This should be available in Resource Object table. (OBJ.OBJ_KEY).itResourceKey
- - An ITResource Key (APP_INSTANCE.ITRESOURCE_KEY) associated with ApplicationInstance.
This key should be available in ITResource table (SVR.SVR_KEY)dataSetName
- - The name of dataset associated with ApplicationInstance.
The attributes in this dataset are used to display form associated with ApplicationInstance in UI.uiFragmentName
- - This is not currently used. Can be used in future.public long getApplicationInstanceKey()
public void setApplicationInstanceKey(long applicationInstanceKey)
applicationInstanceKey
- ApplicationInstance primary key.public java.lang.String getDescription()
public void setDescription(java.lang.String description)
description
- description associated with ApplicationInstance.public long getObjectKey()
public void setObjectKey(long objectKey)
objectKey
- public java.lang.String getObjectName()
public void setObjectName(java.lang.String objectName)
objectName
- object name of the application instance.public java.lang.String getDataSetName()
public void setDataSetName(java.lang.String dataSetName)
dataSetName
- The dataset name that has to be associated with ApplicationInstance.public long getItResourceKey()
public void setItResourceKey(long itResourceKey)
itResourceKey
- public java.lang.String getItResourceName()
public void setItResourceName(java.lang.String itResourceName)
itResourceName
- ITResource name associated with ApplicationInstance.public long getParentKey()
public void setParentKey(long parentKey)
parentKey
- The primary Key of the parent ApplicationInstance.public boolean isSoftDelete()
public void setSoftDelete(boolean softDelete)
softDelete
- A flag representing if ApplicationInstance is soft deleted.public boolean isApplicableToEntitlement()
public void setApplicableToEntitlement(boolean isApplicableToEntitlement)
public FormInfo getAccountForm()
public void setAccountForm(FormInfo accountForm)
accountForm
- FormInfo value objectFormInfo
public java.util.List getChildForms()
FormInfo
public void setChildForms(java.util.List childForms)
childForms
- The list of FormInfo value objects representing child forms.FormInfo
public void addChildForm(FormInfo childForm)
public java.lang.String getApplicationInstanceName()
public void setApplicationInstanceName(java.lang.String applicationInstanceName)
applicationInstanceName
- ApplicationInstance name (APP_INSTANCE.APP_INSTANCE_NAME)public ApplicationInstance.TYPE getType()
public void setType(ApplicationInstance.TYPE type)
type
- ApplicationInstance typepublic java.lang.String getDisplayName()
public void setDisplayName(java.lang.String displayName)
displayName
- the display name of the ApplicationInstance (APP_INSTANCE.APP_INSTANCE_DISPLAY_NAME)public java.lang.String toString()
toString
in class java.lang.Object
public ApplicationInstance getParentAppInstance()
public void setParentAppInstance(ApplicationInstance parentAppInstance)
parentAppInstance
- Parent ApplicationInstance of this ApplicationInstance.public Catalog getCatalogAttributes()
public void setCatalogAttributes(Catalog catalogAttributes)