fuego.papi
Interface ObjectClassInstance

public interface ObjectClassInstance

It represents an ObjectClassInstance, it contains the object class instance metadata and value.
This information can be obtained from a PAPI administrator session.

See Also:

ProcessServiceSession.objectClassInstanceFetchByName(String, String)

Method Summary

String[]	getAssignedParticipants() Returns an array of participants this instance is visible to.
String[]	getAssignedRoles() Returns an array of roles this instance is visible to.
String	getInstanceXml() Returns the serialized instance in xml format.
String	getName() Returns the name for this object class instance.
String	getObjectClass() Returns the object class for this instance.
void	setAssignedParticipants(String[] assignedParticipants) Sets the array of participants this instance is visible to.
void	setAssignedRoles(String[] assignedRoles) Sets the array of roles this instance is visible to.
void	setInstanceXml(String instanceXml) Sets the serialized instance in xml format.

Method Detail

getName

String getName()

Returns the name for this object class instance.

Returns:

the instance's name

getObjectClass

String getObjectClass()

Returns the object class for this instance. The format is [vendor.][application.][module.]name

Returns:

the object class name this instance belongs to.

getAssignedParticipants

String[] getAssignedParticipants()

Returns an array of participants this instance is visible to.

Returns:

The participants' Id this instance is visible to.

getAssignedRoles

String[] getAssignedRoles()

Returns an array of roles this instance is visible to.

Returns:

The roles' Id this instance is visible to.

getInstanceXml

String getInstanceXml()

Returns the serialized instance in xml format.

Returns:

the serialized instance in xml.

setAssignedParticipants

void setAssignedParticipants(String[] assignedParticipants)

Sets the array of participants this instance is visible to.

Parameters:

assignedParticipants - The participants' Id this instance is visible to.

setAssignedRoles

void setAssignedRoles(String[] assignedRoles)

Sets the array of roles this instance is visible to.

Parameters:

assignedRoles - The roles' Id this instance is visible to.

setInstanceXml

void setInstanceXml(String instanceXml)

Sets the serialized instance in xml format.

Parameters:

instanceXml - the serialized instance in xml.