fuego.papi
Interface View

All Superinterfaces:

Serializable

All Known Subinterfaces:

ActivityView, ApplicationsView, AttachmentsView, BookmarkView, ConsultationsView, EditableActivityView, EditableApplicationsView, EditableAttachmentsView, EditableBookmarkView, EditableConsultationsView, EditableFolderView, EditableHistoryView, EditableInstancesView, EditableView, FolderView, HistoryView, InstancesView

public interface View

extends Serializable

Handles different kinds of information using presentations.
There are three different kinds of views, depending on the information to be presented: views for instances, views for applications, and views for attachments. Each view type has its own presentation type. This view cannot be modified. To modify views, use EditableView instead.

Views can be created and stored using ProcessServiceNESession#createView(viewType, viewId, assignedProcesses) and ProcessServiceSession.storeView(View).

Example to get the list of instance IDs for all views:

  String[] viewIds = processServiceSession.getViewIds();
  for (int i=0; i < viewIds.length; i++) {
      View view = processServiceSession.getView(viewIds[i]);
      if (view.getType().isType(ViewType.INSTANCES))
      {
        InstanceInfo[] instances = processServiceSession.getInstancesByView((InstancesView)view);
        for (int j=0; j < instances.length;j++) {
           System.out.println(instances[j].getId())
        }
      }
  }

See Also:

fuego.papi.ViewType, Presentation, fuego.papi.PresentationType, ProcessServiceNESession, ProcessServiceSession

Field Summary

static String	APPLICATIONS_DEFAUTL_ID
static String	ATTACHMENTS_DEFAULT_ID
static String	BOOKMARK_DEFAULT_ID
static String	CONSULTATIONS_DEFAUTL_ID
static String	DEFAULT_OWNER
static String	HISTORY_DEFAUTL_ID
static String	HISTORY_TODAY_DEFAULT_ID
static String	INBOX_DEFAULT_ID

Method Summary

String[]	getAssignedProcesses() Gets the processes assigned to this view.
String[]	getAssignedRoles() Gets the roles assigned to this view.
String	getId() Gets the view ID.
String	getLabel(Locale locale) Gets the label for the given locale.
String	getOwner() Gets the participant ID of the creator of this view.
String	getParentId() Gets parent view ID.
String	getPresentation() Gets the presentation ID assigned to this view.
PresentationType	getPresentationType() Gets the type of the presentation assigned to this view.
ViewType	getType() Gets the type of the view
boolean	hasType(ViewType viewType) Returns true if the view is a subtype of the specified view type.
boolean	isCustom() Returns true if this view is a user-created view.
boolean	isHidden() Returns true if this view is hidden.
boolean	isReadOnly() Returns true if this view is read only.
boolean	isTransient() Returns true if this view was stored.

Field Detail

APPLICATIONS_DEFAUTL_ID

public static final String APPLICATIONS_DEFAUTL_ID

See Also:

Constant Field Values

ATTACHMENTS_DEFAULT_ID

public static final String ATTACHMENTS_DEFAULT_ID

See Also:

Constant Field Values

BOOKMARK_DEFAULT_ID

public static final String BOOKMARK_DEFAULT_ID

See Also:

Constant Field Values

CONSULTATIONS_DEFAUTL_ID

public static final String CONSULTATIONS_DEFAUTL_ID

See Also:

Constant Field Values

DEFAULT_OWNER

public static final String DEFAULT_OWNER

See Also:

Constant Field Values

HISTORY_DEFAUTL_ID

public static final String HISTORY_DEFAUTL_ID

See Also:

Constant Field Values

HISTORY_TODAY_DEFAULT_ID

public static final String HISTORY_TODAY_DEFAULT_ID

See Also:

Constant Field Values

INBOX_DEFAULT_ID

public static final String INBOX_DEFAULT_ID

See Also:

Constant Field Values

Method Detail

getAssignedProcesses

public String[] getAssignedProcesses()

Gets the processes assigned to this view.

Returns:

array of processes identification

See Also:

Process.getId()

getAssignedRoles

public String[] getAssignedRoles()

Gets the roles assigned to this view. The assigned roles are all the roles assigned to processes assigned to this view.

Returns:

array of roles identification

See Also:

Process.getRoles()

isCustom

public boolean isCustom()

Returns true if this view is a user-created view.

Returns:

true if this view is a user-created view

isHidden

public boolean isHidden()

Returns true if this view is hidden.

Returns:

true if this view is hidden

getId

public String getId()

Gets the view ID.

Returns:

view ID

getLabel

public String getLabel(Locale locale)

Gets the label for the given locale.

Parameters:

locale - the desired locale

Returns:

the label for the given locale

getOwner

public String getOwner()

Gets the participant ID of the creator of this view.

Returns:

participant ID

See Also:

Participant.getUid()

getParentId

public String getParentId()

Gets parent view ID. If this view does not have a parent, returns null.

Returns:

parent view ID or null if the view does not have a parent view

See Also:

getId()

getPresentation

public String getPresentation()

Gets the presentation ID assigned to this view.

Returns:

presentation ID

See Also:

Presentation.getId()

getPresentationType

public PresentationType getPresentationType()

Gets the type of the presentation assigned to this view.

Returns:

presentation type

See Also:

Presentation.getType(), PresentationType

isReadOnly

public boolean isReadOnly()

Returns true if this view is read only.

Returns:

true if this view is read only

isTransient

public boolean isTransient()

Returns true if this view was stored.

Returns:

true if this view was stored

getType

public ViewType getType()

Gets the type of the view

Returns:

view type

See Also:

ViewType

hasType

public boolean hasType(ViewType viewType)

Returns true if the view is a subtype of the specified view type.

Parameters:

viewType - parent view type

Returns:

true if it is a subtype of the specified type

See Also:

ViewType