bea.com | products | dev2dev | support | askBEA

Download Docs | Site Map | Glossary
Search

Programming BPM Client Apps

Value Object Summary

This appendix describes the BPM value objects and their methods, including the following:

- BusinessCalendarInfo Object

- EventKeyInfo Object

- InstanceInfo Object

- OrganizationInfo Object

- PermissionInfo Object

- RepositoryFolderInfo Object

- RepositoryFolderInfoHelper Object

- RerouteInfo Object

- RoleInfo Object

- RolePermissionInfo Object

- TaskInfo Object

- TemplateDefinitionInfo Object

- TemplateInfo Object

- UserInfo Object

- UserPermissionInfo Object

- VariableInfo Object

- VersionInfo Object

- XMLEntityInfo Object

- XMLEntityInfoHelper Object

For more information about accessing object data, see Using Value Objects.

BusinessCalendarInfo Object

The com.bea.wlpi.common.BusinessCalendarInfo object maintains object data pertaining to business calendars.

You can use the following constructors to create a new BusinessCalendarInfo object:

>     public BusinessCalendarInfo(
>       java.lang.String id,
>       java.lang.String name,
>       java.lang.String timezone,
>       java.lang.String xml
>     )

>     public BusinessCalendarInfo(
>       java.lang.String id,
>       java.lang.String name,
>       java.lang.String timezone,
>       java.lang.String xml,
>       boolean published
>     )

The following table describes the BusinessCalendarInfo object data, the constructor parameters used to define the data, and the get and set methods that can be used to access that data after the object is defined.

Table B-1 BusinessCalendarInfo Object Data

Object Data | Constructor Parameter | Get Method | Set Method
--- | --- | --- | ---
Business calendar ID | id | public java.lang.String getId() | public void setId(java.lang.String id)
Business calendar name | name | public java.lang.String getName() | public void setName(java.lang.String name)
Timezone in which the business calendar operates | timezone | public java.lang.String getTimeZone() | public void setTimeZone(java.lang.String id)
Business calendar definition (XML) For a description of the Business Calendar DTD format, see Business Calendar DTD. | xml | public java.lang.String getXML() | public void setXML(java.lang.String xml)
Boolean flag specifying whether or not the business calendar is published. | published | public boolean isPublished() | N/A

For more information, see the com.bea.wlpi.common.BusinessCalendarInfo javadoc.

EventKeyInfo Object

The com.bea.wlpi.common.EventKeyInfo object maintains object data pertaining to event keys.

An event key specifies a unique value that is encoded as part of the event data, and that is used to identify workflow definitions or instances associated with an incoming XML document. The process engine generates an EventKey table that associates a workflow expression to an event based on the event content type and descriptor. The workflow expression is used to evaluate the event key value for an incoming event.

You can use the following constructor to create a new EventKeyInfo object:

>     public EventKeyInfo(
>       java.lang.String contentType,
>       java.lang.String eventDescriptor,
>       java.lang.String expr,
>       java.lang.String plugin,
>       int fieldId
>     )

The following table describes the EventKeyInfo object data, the constructor parameters used to define the data, and the get and set methods that can be used to access that data after the object is defined.

Note: For more information about programming plug-ins, see Programming BPM Plug-Ins for WebLogic Integration.

Table B-2 EventKeyInfo Object Data

Object Data | Parameter | Get Method | Set Method
--- | --- | --- | ---
MIME Content type (for example, text/xml) | contentType | public final java.lang.String getContentType() | N/A
If the MIME Content type is set to text/xml, specifies one of the following: Public ID of the XML document DTD System ID if no public ID is quoted Root element name if no DOCTYPE is specified Otherwise, specifies an event descriptor, in a plug-in defined format | eventDescriptor | public final java.lang.String getEventDescriptor() | N/A
Expression that yields a unique event key for a document with the specified content type and format description | expr | public final java.lang.String getExpr() | public final void setExpr(java.lang.String expr)
Plug-in that supplies the field type required to evaluate the expression; if null, and the content type is text/xml, the default XML field type is used | plugin | public final java.lang.String getPlugin() | N/A
Field ID assigned by the plug-in | fieldId | public final int getFieldId() | N/A

For more information, see the com.bea.wlpi.common.EventKeyInfo javadoc.

InstanceInfo Object

The com.bea.wlpi.common.InstanceInfo object maintains object data pertaining to workflow instances.

You can use the following constructors to create a new InstanceInfo object:

>     public InstanceInfo(
>       java.lang.String id,
>       java.lang.String templateId,
>       java.lang.String templateDefinitionId,
>       java.lang.String name,
>       java.lang.String initiator,
>       java.lang.String parentId,
>       java.sql.Timestamp started,
>       java.sql.Timestamp completed,
>       java.lang.String idString,
>       int state,
>       java.lang.String comment
>     )

>     public InstanceInfo(
>       java.lang.String id,
>       java.lang.String templateId,
>       java.lang.String templateDefinitionId,
>       java.lang.String name,
>       java.lang.String initiator,
>       java.lang.String parentId,
>       java.sql.Timestamp started,
>       java.sql.Timestamp completed,
>       java.lang.String idString,
>       int state,
>       java.lang.String comment
>       java.util.Map pluginData
>     )

The following table describes the InstanceInfo object data, the constructor parameters used to define the data, and the get methods that can be used to access that data after the object is defined.

Note: For more information about programming plug-ins, see Programming BPM Plug-Ins for WebLogic Integration.

Table B-3 InstanceInfo Object Data

Object Data | Constructor Parameter | Get Method
--- | --- | ---
Instance ID | id | public final java.lang.String getId()
Template ID | templateId | public final java.lang.String getTemplateId()
Template definition ID | templateDefinitionId | public final java.lang.String getTemplateDefinitionId()
Template definition name | name | public final java.lang.String getName()
Initiator ID | initiator | public final java.lang.String getInitiator()
Parent ID | parentId | public final java.lang.String getParentId()
Date and time at which the workflow was started | started | public final java.sql.Timestamp getStarted()
Date and time at which the workflow was completed | completed | public final java.sql.Timestamp getCompleted()
Instance label | idString | public final java.lang.String getIdString()
Workflow instance state that can be expressed as one of the following static integer values: WORKFLOW_STATE_ACTIVE: instance is running normally WORKFLOW_STATE_SUSPENDED: instance is suspended | state | public final int getState()
Comment | comment | public final java.lang.String getComment()
Plug-in data | pluginData | public java.lang.Object getPluginInstanceData(java.lang.String pluginName)

For more information, see the com.bea.wlpi.common.InstanceInfo javadoc.

OrganizationInfo Object

The com.bea.wlpi.common.OrganizationInfo object maintains object data pertaining to the organization.

You can use the following constructors to create a new OrganizationInfo object:

>     public OrganizationInfo(
>       java.lang.String orgId
>     )

>     public OrganizationInfo(
>       java.lang.String orgId,
>       java.lang.String calendarId
>     )

The following table describes the OrganizationInfo object data, the constructor parameters used to define the data, and the get and set methods that can be used to access that data after the object is defined.

Table B-4 OrganizationInfo Object Data

Object Data | Constructor Parameter | Get Method | Set Method
--- | --- | --- | ---
Organization ID | orgId | public final java.lang.String getOrgId() | N/A
ID of the business calendar to be used | calendarId | public final java.lang.String getCalendarId() | public final void setCalendarId(java.lang.String calendarId)

For more information, see the com.bea.wlpi.common.OrganizationInfo javadoc.

PermissionInfo Object

The com.bea.wlpi.common.security.PermissionInfo object maintains permission information for a principal (role or user), as defined by the associated com.bea.wlpi.common.security.EnumPermission object.

You can use the following constructor to create a a new PermissionInfo object:

>     public PermissionInfo(
>       java.lang.String principalId
>     )

The following table describes the PermissionInfo object data, the constructor parameters used to define the data, and the get and set methods that can be used to access that data after the object is defined.

Table B-5 PermissionInfo Object Data

Object Data | Constructor Parameter | Get Method | Set Method
--- | --- | --- | ---
Principal ID | principalId | public java.lang.String getPrincipalId() | N/A
Permission level and value The permission level can be set to one of the com.bea.wlpi.common.security.EnumPermission static integer values defined in the table Permissions Overview. The permission value can be set to true (enabled) or false (disabled). | N/A | N/A | public void setPermission(com.bea.wlpi.common. security.EnumPermission permission, boolean value)
Boolean flag specifying whether or not a permission level is in effect For more information about the permission levels that can be set, see Permissions Overview. | N/A | public boolean hasPermission(com.bea.wlpi.common. security.EnumPermission permission) | N/A

For more information, see the com.bea.wlpi.common.security.PermissionInfo javadoc. See also RolePermissionInfo Object and UserPermissionInfo Object.

RepositoryFolderInfo Object

Note: The com.bea.wlpi.common.RepositoryFolderInfoHelper object provides an auxiliary class to the com.bea.eci.repository.helper.RepositoryFolderInfo object to support the importing and exporting of object data. For more information, see RepositoryFolderInfoHelper Object.

The com.bea.eci.repository.helper.RepositoryFolderInfo object maintains object data pertaining to the folders within the XML repository.

You can use the following constructor to create a new OrganizationInfo object:

>     public RepositoryFolderInfo(
>       java.lang.String type,
>       java.lang.String name,
>       java.lang.String desc,
>       java.lang.String notes
>     )

The following table describes the RepositoryFolderInfo object data, the constructor parameters used to define the data, and the get methods that can be used to access that data after the object is defined.

Table B-6 RepositoryFolderInfo Object Data

Object Data | Constructor Parameter | Get Method
--- | --- | ---
Folder type | type | public java.lang.String getType()
Folder name | name | public java.lang.String getName()
Folder description | desc | public java.lang.String getDescription()
Folder notes | notes | public java.lang.String getNotes()
Date on which folder was created | N/A | public java.sql.Timestamp getCreatedOn()
Date on which folder was last modified | N/A | public java.sql.Timestamp getLastModifiedOn()

For more information, see the com.bea.eci.repository.helper.RepositoryFolderInfo javadoc.

RepositoryFolderInfoHelper Object

The com.bea.wlpi.common.RepositoryFolderInfoHelper object provides an auxiliary class to the com.bea.eci.repository.helper.RepositoryFolderInfo object to support the importing and exporting of object data.

You can use the following constructors to create a new RepositoryFolderInfoHelper object:

>     public RepositoryFolderHelperInfo(
>       java.lang.String type,
>       java.lang.String name,
>       java.lang.String desc,
>       java.lang.String notes
>     )

>     public RepositoryFolderInfoHelper(
>       java.lang.String type,
>       java.lang.String name,
>       java.lang.String desc,
>       java.lang.String notes,
>       com.bea.wlpi.common.RepositoryFolderInfoHelper parent
>     )

The following table describes the RepositoryFolderInfoHelper object data, the constructor parameters used to define the data, and the get methods that can be used to access that data after the object is defined.

Table B-7 RepositoryFolderInfo Object Data

Object Data | Constructor Parameter | Get Method | Set Method
--- | --- | --- | ---
Folder type | type | public java.lang.String getFolderType() | N/A
Folder name | name | public java.lang.String getName() | N/A
Folder description | desc | public java.lang.String getDescription() | N/A
Folder notes | notes | public java.lang.String getNotes() | N/A
Parent | parent | public com.bea.wlpi.common. RepositoryFolderInfoHelper getParent() | public void setParent(com.bea.wlpi.common. RepositoryFolderInfoHelper p)
XML repository publishable object contents | N/A | public java.lang.Object getContents() | N/A
XML repository publishable entry name | N/A | public java.lang.String getEntryName() | N/A
XML repository publishable owner name | N/A | public java.lang.String getOwnerName() | N/A
XML repository publishables referenced by specified publishable objects | N/A | public java.util.List getReferencedPublishables(java.util.Map publishables) | N/A
XML repository publishable object type | N/A | public int getType() | N/A

For more information, see the com.bea.wlpi.common.RepositoryFolderInfoHelper javadoc.

RerouteInfo Object

The com.bea.wlpi.common.RerouteInfo object maintains object data pertaining to task reroutes.

You can use the following constructor to create a new RerouteInfo object:

>     public RerouteInfo(
>       java.lang.String id,
>       java.lang.String from,
>       java.lang.String to,
>       int type,
>       java.sql.Timestamp effective,
>       java.sql.Timestamp expiry
>     )

The following table describes the RerouteInfo object data, the constructor parameters used to define the data, and the get and set methods that can be used to access that data after the object is defined.

Table B-8 RerouteInfo Object Data

Object Data | Constructor Parameter | Get Method | Set Method
--- | --- | --- | ---
Task reroute ID | id | public final java.lang.String getId() | N/A
User or role for whom the task will be rerouted | from | public final java.lang.String getFrom() | public void setFrom(java.lang.String from)
User or role to whom the rerouted tasks will be assigned | to | public final java.lang.String getTo() | public void setTo(java.lang.String to)
Type of task reroute. Can be represented by one of the following static integer values, defined by static final members of the ReRouteInfo class: TYPE_USER: Reroute task to another user TYPE_USERINROLE: Reroute task to a user in a role, using load balancing TYPE_ROLE: Reroute task to a role | type | public final int getType() | public void setType(int type)
Date and time at which the task reroute becomes effective | effective | public final java.sql.Timestamp getEffective() | public void setEffective(java.sql.Timestamp effective)
Date and time at which the task reroute expires | expiry | public final java.sql.Timestamp getExpiry() | public void setExpiry(java.sql.Timestamp expiry)

For more information, see the com.bea.wlpi.common.RerouteInfo javadoc.

RoleInfo Object

The com.bea.wlpi.common.RoleInfo object maintains object data pertaining to roles.

You can use the following constructors to create a new RoleInfo object:

>     public RoleInfo(
>       java.lang.String roleId,
>       java.lang.String orgId
>     )

>     public RoleInfo(
>       java.lang.String roleId,
>       java.lang.String orgId,
>       java.lang.String calendarId
>     )

>     public RoleInfo(
>       java.lang.String roleId,
>       java.lang.String orgId,
>       java.lang.String calendarId,
>       java.lang.String groupId
>     )

The following table describes the RoleInfo object data, the constructor parameters used to define the data, and the get and set methods that can be used to access that data after the object is defined.

Table B-9 RoleInfo Object Data

Object Data | Constructor Parameter | Get Method | Set Method
--- | --- | --- | ---
Role ID | roleId | public final java.lang.String getRoleId() | N/A
ID of the organization within which the role is defined | orgId | public final java.lang.String getOrgId() | N/A
ID of the business calendar to be used | calendarId | public final java.lang.String getCalendarId() | public void setCalendarId(java.lang.String calendarId)
ID of the security realm group to which this role maps | groupId | public final java.lang.String getGroupId() | public final java.lang.String setGroupId(java.lang.String groupId)

For more information, see the com.bea.wlpi.common.RoleInfo javadoc.

RolePermissionInfo Object

The com.bea.wlpi.common.security.RolePermissionInfo object maintains object data pertaining to role permissions, as defined by the associated com.bea.wlpi.common.security.EnumPermission object.

You can use the following constructors to create a new RolePermissionInfo object:

>     public RolePermissionInfo(
>       java.lang.String roleId,
>       java.lang.String orgId
>     )

>     public RolePermissionInfo(
>       java.lang.String roleId,
>       java.lang.String orgId,
>       java.lang.String groupId
>     )

The following table describes the RolePermissionInfo object data, the constructor parameters used to define the data, and the get and set methods that can be used to access that data after the object is defined.

Note: The RolePermissionInfo class extends the PermissionInfo class. For information about the get and set methods, including how to set permissions for a specific role, see PermissionInfo Object.

Table B-10 RolePermissionInfo Object Data

Object Data | Constructor Parameter | Get Method | Set Method
--- | --- | --- | ---
Role ID | roleId | N/A | N/A
ID of the organization within which the role is defined | orgId | public java.lang.String getOrgId() | public void setOrgId(java.lang.String orgId)
ID of the security realm group within which the role is defined | groupId | public java.lang.String getGroupId() | public void setGroupId(java.lang.String groupId)

For more information, see the com.bea.wlpi.common.security.RolePermissionInfo javadoc. See also PermissionInfo Object.

TaskInfo Object

The com.bea.wlpi.common.TaskInfo object maintains object data pertaining to workflow tasks.

You can use the following constructor to create a new TaskInfo object:

>     public TaskInfo(
>       java.lang.String templateId,
>       java.lang.String templateDefinitionId,
>       java.lang.String instanceId,
>       java.lang.String taskId,
>       java.lang.String name,
>       java.lang.String assignee,
>       boolean assigneeIsRole,
>       java.lang.String workflow,
>       java.lang.String workflowId,
>       int priority,
>       java.sql.Timestamp started,
>       java.sql.Timestamp completed,
>       java.sql.Timestamp due,
>       java.lang.String comment,
>       boolean doneWithoutDoit,
>       boolean doitIfDone,
>       boolean unmarkDone,
>       boolean modifiable,
>       boolean reassignment
>     )

The following table describes the TaskInfo object data, the constructor parameters used to define the data, and the get methods that can be used to access that data after the object is defined.

Table B-11 TaskInfo Object Data

Object Data | Constructor Parameter | Get Method
--- | --- | ---
Template ID | templateId | public final java.lang.String getTemplateId()
Template definition ID | templateDefinitionId | public final java.lang.String getTemplateDefinitionId()
Instance ID | instanceId | public final java.lang.String getInstanceId()
Task ID | taskId | public final java.lang.String getTaskId()
Task name | name | public final java.lang.String getTaskName()
Assignee (user or role) to which the task is assigned | assignee | public final java.lang.String getAssignee()
Boolean flag specifying whether or not the assignee is a role | assigneeIsRole | public final boolean isAssignedToRole()
Workflow name | workflow | public final java.lang.String getWorkflowName()
Workflow ID | workflowId | public final java.lang.String getWorkflowId()
Task priority | priority | public final int getPriority()
Date and time at which the task was started | started | public final java.sql.Timestamp getStarted()
Date and time at which the task was completed | completed | public final java.sql.Timestamp getCompleted()
Date and time at which the task should be due | due | public final Timestamp getDue()
Comment | comment | public final java.lang.String getComment()
Permission to mark a task as complete | doneWithoutDoIt | public final boolean getDoneWithoutDoIt()
Permission to execute a task after it has been marked as complete | doitIfDone | public final boolean getDoitIfDone()
Permission to mark a task as incomplete | unmarkDone | public final boolean getUnmarkDone()
Permission to modify the task run-time properties | modifiable | public final boolean getModifiable()
Permission to reassign a task instance to another participant | reassignment | public final boolean getReassignment()
Task status that can be represented by one of the following static integer values, defined by static final members of the TaskInfo class: STATUS_COMPLETE: task is complete STATUS_INACTIVE: task has not yet started STATUS_OVERDUE: task has started, but is not yet complete and the due date is past STATUS_PENDING: task has started, but is not yet complete | N/A | public final int getStatus()

For more information, see the com.bea.wlpi.common.TaskInfo javadoc.

TemplateDefinitionInfo Object

The com.bea.wlpi.common.TemplateDefinitionInfo object maintains object data pertaining to the template definition.

You can use the following constructors to create a new TemplateDefinitionInfo object:

>     public TemplateDefinitionInfo(
>       java.lang.String id,
>       java.sql.Timestamp effective,
>       java.sql.Timestamp expiry,
>       boolean active
>     )

>     public TemplateDefinitionInfo(
>       java.lang.String id,
>       java.sql.Timestamp effective,
>       java.sql.Timestamp expiry,
>       boolean active,
>       java.lang.String templateId,
>       java.lang.String templateName
>     )

>     public TemplateDefinitionInfo(
>       java.lang.String id,
>       java.sql.Timestamp effective,
>       java.sql.Timestamp expiry,
>       boolean active,
>       java.lang.String templateId,
>       java.lang.String templateName,
>       java.lang.String xml,
>       java.utilMap pluginData,
>       boolean published
>     )

The following table describes the TemplateDefinitionInfo object data, the constructor parameters used to define the data, and the get methods that can be used to access that data after the object is defined.

Note: For more information about programming plug-ins, see Programming BPM Plug-Ins for WebLogic Integration.

Table B-12 TemplateDefinitionInfo Object Data

Object Data | Constructor Parameter | Get Method
--- | --- | ---
Template definition ID | id | public final java.lang.String getId()
Effective date for the template definition | effective | public final java.sql.Timestamp getEffective()
Expiration date for the template definition | expiry | public final java.sql.Timestamp getTemplateDefinition()
Boolean flag specifying whether the template definition is marked active | active | public final boolean getActive()
Template ID | templateId | public final java.lang.String getTemplateId()
Template name | templateName | public final java.lang.String getTemplateName()
Workflow template definition in XML format | xml | public java.lang.String getContents()
Plug-in data | pluginData | public java.util.Map getPluginData() public com.bea.wlpi.common.plugin.PluginObject getPluginData(java.lang.String pluginName)
Boolean flag specifying whether or not the template definition is published. | published | public boolean isPublished()

For more information, see the com.bea.wlpi.common.TemplateDefinitionInfo javadoc.

TemplateInfo Object

The com.bea.wlpi.common.TemplateInfo object maintains object data pertaining to the template.

You can use the following constructors to create a new TemplateInfo object:

>     public TemplateInfo(
>       java.lang.String id,
>       java.lang.String name
>     )

>     public TemplateInfo(
>       java.lang.String id,
>       java.lang.String name,
>       java.lang.String xml
>     )

>     public TemplateInfo(
>       java.lang.String id,
>       java.lang.String name,
>       java.lang.String xml,
>       java.util.Map pluginData,
>       boolean published
>     )

The following table describes the TemplateInfo object data, the constructor parameters used to define the data, and the get methods that can be used to access that data after the object is defined.

Table B-13 TemplateInfo Object Data

Object Data | Constructor Parameter | Get Method
--- | --- | ---
Template ID | id | public final java.lang.String getId()
Template name | name | public final java.lang.String getName()
Plug-in defined template properties in XML form | xml | N/A
Plug-in data | pluginData | public java.util.Map getPluginData() public com.bea.wlpi.common.plugin.PluginObject getPluginData(java.lang.String pluginName)
Boolean flag specifying whether or not the template is published | published | public boolean isPublished()

For more information, see the com.bea.wlpi.common.TemplateInfo javadoc.

UserInfo Object

The com.bea.wlpi.common.UserInfo object maintains object data pertaining to the user.

You can use the following constructors to create a new UserInfo object:

>     public UserInfo(
>       java.lang.String userId
>     )

>     public UserInfo(
>       java.lang.String userId,
>       java.lang.String eMailAddress,
>       java.lang.String defaultOrgId,
>       java.lang.String calendarId
>     )

The following table describes the UserInfo object data, the constructor parameters used to define the data, and the get and set methods that can be used to access that data after the object is defined.

Table B-14 UserInfo Object Data

Object Data | Constructor Parameter | Get Method | Set Method
--- | --- | --- | ---
User ID | userId | public final java.lang.String getUserId() | N/A
User e-mail address | eMailAddress | public final java.lang.String getEMailAddress() | public void setEMailAddress(java.lang.String eMailAddress)
ID of the default organization within which the user is defined | defaultOrgId | public final java.lang.String getDefaultOrgId() | public void setDefaultOrgId(java.lang.String defaultOrgId)
ID of the business calendar to be used | calendarId | public final java.lang.String getCalendarId() | public void setCalendarId(java.lang.String calendarId)

For more information, see the com.bea.wlpi.common.UserInfo javadoc.

UserPermissionInfo Object

The com.bea.wlpi.common.security.UserPermissionInfo object maintains object data pertaining to user permissions.

You can use the following constructors to create a new UserPermissionInfo object:

>     public UserPermissionInfo(
>       java.lang.String userId
>     )

>     public UserPermissionInfo(
>       java.lang.String userId,
>       java.util.List roles
>     )

The following table describes the UserPermissionInfo object data, the constructor parameters used to define the data, and the get and set methods that can be used to access that data after the object is defined.

Table B-15 RolePermissionInfo Object Data

Object Data | Constructor Parameter | Get Method | Set Method
--- | --- | --- | ---
User ID | userId | N/A | N/A
ID of the roles to which the user belongs | roleId | public java.util.List getRoles() | N/A

For more information, see the com.bea.wlpi.common.security.UserPermissionInfo javadoc.

VariableInfo Object

The com.bea.wlpi.common.VariableInfo object maintains object data pertaining to the workflow variables.

You can use the following constructors to create a new VariableInfo object:

>     public VariableInfo(
>       java.lang.String name,
>       java.lang.Object value
>     )

>     public VariableInfo(
>       java.lang.String name,
>       java.lang.String type
>     )

The following table describes the VariableInfo object data, the constructor parameters used to define the data, and the get methods that can be used to access that data after the object is defined.

Table B-16 VariableInfo Object Data

Object Data | Constructor Parameter | Get Method
--- | --- | ---
Variable name | name | public final java.lang.String getName()
Variable value | value | public final java.lang.String getValue()
Variable type | type | public final java.lang.String getType() You can also use the following methods to validate the type: static void validateType(java.lang.String type) static void validateTypes(java.lang.String[] types)

For more information, see the com.bea.wlpi.common.VariableInfo javadoc.

VersionInfo Object

The com.bea.wlpi.common.VersionInfo object maintains object data pertaining to the version number.

You can use the following constructors to create a new VersionInfo object:

>     public VersionInfo(
>       int majorVersion,
>       int minorVersion,
>       int volume,
>       java.lang.String build,
>       java.lang.String name
>     )

>     public VersionInfo(
>       int majorVersion,
>       int minorVersion,
>       java.lang.String build,
>       java.lang.String name
>     )

>     public VersionInfo(
>       java.lang.String version
>     )

The following table describes the VersionInfo object data, the constructor parameters used to define the data, and the get methods that can be used to access that data after the object is defined.

Table B-17 VersionInfo Object Data

Object Data | Constructor Parameter | Get Method
--- | --- | ---
Major version number | majorVersion | public final int getMajorVersion()
Minor version number | minorVersion | public final int getMinorVersion()
Volume number | volume | public final int getVolume()
Build number or name | build | public final java.lang.String getBuild()
Version name | name | public final java.lang.String getName()
Default version | N/A | public static final VersionInfo getDefaultVersion()
Version number in decimal format containing between two and four integer components (separated by dots) specifying the following data (in the order listed): majorVersion, minorVersion, volume, and build values | version | N/A

For more information, see the com.bea.wlpi.common.VersionInfo javadoc.

XMLEntityInfo Object

Note: The com.bea.wlpi.common.XMLEntityInfoHelper object provides an auxiliary class to the com.bea.eci.repository.helper.XMLEntityInfo object to support the importing and exporting of object data. For more information, see XMLEntityInfoHelper Object.

The com.bea.eci.repository.helper.XMLEntityInfo object maintains object data pertaining to the entities within the XML repository.

You can use the following constructors to create a new XMLEntityInfo object:

>     public XMLEntityInfo(
>       int type,
>       java.lang.String name,
>       java.lang.String desc,
>       java.lang.String notes
>     )

>     public XMLEntityInfo(
>       int type,
>       java.lang.String name,
>       java.lang.String desc,
>       java.lang.String notes,
>       byte[] content
>     )

>     public XMLEntityInfo(
>       int type,
>       java.lang.String name,
>       java.lang.String desc,
>       java.lang.String notes,
>       java.sql.Timestamp createdOn,
>       java.sql.Timestamp lastModifiedOn
>     )

>     public XMLEntityInfo(
>       int type,
>       java.lang.String name,
>       java.lang.String desc,
>       java.lang.String notes,
>       java.sql.Timestamp createdOn,
>       java.sql.Timestamp lastModifiedOn,
>       java.lang.String content
>     )

The following table describes the XMLEntityInfoHelper object data, the constructor parameters used to define the data, and the get methods that can be used to access that data after the object is defined.

Table B-18 XMLEntityInfo Object Data

Object Data | Constructor Parameter | Get Method
--- | --- | ---
Entity type | type | public java.lang.String getType()
Entity name | name | public java.lang.String getName()
Entity description | desc | public java.lang.String getDescription()
Entity notes | notes | public java.lang.String getNotes()
Entity contents (as array of bytes) | content | public byte[] getContent()
Entity creation date | createdOn | public java.sql.Timestamp getCreatedOn()
Entity last modified date | lastModifiedOn | public java.sql.Timestamp getLastModifiedOn()
Entity contents (as a string) | content | public java.lang.String getContentAsString()

For more information, see the com.bea.eci.repository.helper.XMLEntityInfo javadoc.

XMLEntityInfoHelper Object

The com.bea.wlpi.common.XMLEntityInfoHelper object provides an auxiliary class to the com.bea.eci.repository.helper.XMLEntityInfo object to support the importing and exporting of object data.

You can use the following constructor to create a new XMLEntityInfoHelper object:

>     public XMLEntityInfo(
>       int type,
>       java.lang.String name,
>       java.lang.String desc,
>       java.lang.String notes
>     )

The following table describes the XMLEntityInfoHelper object data, the constructor parameters used to define the data, and the get methods that can be used to access that data after the object is defined.

Table B-19 XMLEntityInfoHelper Object Data

Object Data | Constructor Parameter | Get Method | Set Method
--- | --- | --- | ---
Entity type | type | public java.lang.String getEntityType() | N/A
Entity name | name | public java.lang.String getName() | N/A
Entity description | desc | public java.lang.String getDescription() | N/A
Entity notes | notes | public java.lang.String getNotes() | N/A
Parent folder | N/A | public java.util.List getParentFolders() | public void addParentFolder(com.bea.wlpi.common.RepositoryFolderInfoHelper rfih)
XML Repository publishable object contents | N/A | public java.lang.Object getContents() | N/A
XML Repository publishable entry name | N/A | public java.lang.String getEntryName() | N/A
XML Repository publishable owner name | N/A | public java.lang.String getOwnerName() | N/A
XML Repository publishables referenced by specified publishable objects | N/A | public java.util.List getReferencedPublishables(java.util.Map publishables) | N/A
XML repository publishable object type | N/A | public int getType() | N/A

For more information, see the com.bea.wlpi.common.XMLEntityInfoHelper javadoc.