ALBPM Process API

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

This class is used to show information with a specific representation. There are three different kind of views, depending on the information that will be shown, (Instances, Applications, Attachments). Each type of view has its own presentation type. You can obtain the stored views or create new ones using ProcessServiceSession. To modify a View you must obtain an EditableView, to do that, you can call the method ProcessServiceSession.getEditableView(View) with the view as argument. To store the modified view, you must obtain a ProcessServiceSession and call the method storeView(View). i.e. ProcessService processService = ProcessService.create("DirectoryURL"); ConnectionPassport passport = processService.createPassport("UserID"); ProcessServiceSession session = processService.createSession(psssport, "UserHost"); String[] viewIds = neSession.getViewIds(); for (int i=0; i < viewIds.length; i++) { View view = session.getView(viewIds[i]); EditableView editView = session.getEditableView(view); editView.setLabel("View Number " + i, java.util.Locale.ENGLISH); session.storeView(editView); } EditableView editView = session.createView(ViewType.INSTANCES, "MyViewID", new String[] {"DeployedProcessVersion" });

See Also:
ViewType, Presentation, PresentationType, 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
           
static long serialCheck
           
static long serialVersionUID
           
 
Method Summary
 String[] getAssignedProcesses()
          Returns the process identification assigned.
 String[] getAssignedRoles()
          Returns the roles identification where this view is assigned
 String getId()
          Returns the view identification
 String getLabel(Locale locale)
          Returns the label for a given locale
 String getOwner()
          Returns the participant identification who created the view
 String getParentId()
          Returns the parent view identification, if this view doesn't have parent returns null.
 String getPresentation()
          Returns the presentation identification assigned
 PresentationType getPresentationType()
          Returns the type of the presentation assinged
 ViewType getType()
          Returns the type of the view
 boolean hasType(ViewType viewType)
          Returns if the view is a subtype of given view type
 boolean isCustom()
          Returns if this view was created by the user
 boolean isHidden()
          Returns if this view is hidden or not
 boolean isReadOnly()
          Returns if read only or not
 boolean isTransient()
          Returns if was stored or not
 

Field Detail

APPLICATIONS_DEFAUTL_ID

@NonNls
static final String APPLICATIONS_DEFAUTL_ID
See Also:
Constant Field Values

ATTACHMENTS_DEFAULT_ID

@NonNls
static final String ATTACHMENTS_DEFAULT_ID
See Also:
Constant Field Values

BOOKMARK_DEFAULT_ID

@NonNls
static final String BOOKMARK_DEFAULT_ID
See Also:
Constant Field Values

CONSULTATIONS_DEFAUTL_ID

@NonNls
static final String CONSULTATIONS_DEFAUTL_ID
See Also:
Constant Field Values

DEFAULT_OWNER

@NonNls
static final String DEFAULT_OWNER
See Also:
Constant Field Values

HISTORY_DEFAUTL_ID

@NonNls
static final String HISTORY_DEFAUTL_ID
See Also:
Constant Field Values

HISTORY_TODAY_DEFAULT_ID

@NonNls
static final String HISTORY_TODAY_DEFAULT_ID
See Also:
Constant Field Values

INBOX_DEFAULT_ID

@NonNls
static final String INBOX_DEFAULT_ID
See Also:
Constant Field Values

serialCheck

static final long serialCheck
See Also:
Constant Field Values

serialVersionUID

static final long serialVersionUID
See Also:
Constant Field Values
Method Detail

getAssignedProcesses

String[] getAssignedProcesses()
Returns the process identification assigned.

Returns:
the process identification
See Also:
Process.getId()

getAssignedRoles

String[] getAssignedRoles()
Returns the roles identification where this view is assigned

Returns:
the roles identification
See Also:
Process.getRoles()

isCustom

boolean isCustom()
Returns if this view was created by the user

Returns:
true if the view was created by the user, unless returns false;

isHidden

boolean isHidden()
Returns if this view is hidden or not

Returns:
true if the view is hidden, unless returns false

getId

String getId()
Returns the view identification

Returns:
the view identification

getLabel

String getLabel(Locale locale)
Returns the label for a given locale

Parameters:
locale -
Returns:
The label of the view in the given locale.

getOwner

String getOwner()
Returns the participant identification who created the view

Returns:
the participant identification
See Also:
Participant.getUid()

getParentId

String getParentId()
Returns the parent view identification, if this view doesn't have parent returns null.

Returns:
the parent view identification
See Also:
getId()

getPresentation

String getPresentation()
Returns the presentation identification assigned

Returns:
the presentation identification
See Also:
Presentation.getId()

getPresentationType

PresentationType getPresentationType()
Returns the type of the presentation assinged

Returns:
the presentation type
See Also:
Presentation.getType(), PresentationType

isReadOnly

boolean isReadOnly()
Returns if read only or not

Returns:
true if it read only and false if not.

isTransient

boolean isTransient()
Returns if was stored or not

Returns:
true if was stored and false if not.

getType

ViewType getType()
Returns the type of the view

Returns:
the view type
See Also:
ViewType

hasType

boolean hasType(ViewType viewType)
Returns if the view is a subtype of given view type

Parameters:
viewType - the parent view type
Returns:
true if a subtype and false if not
See Also:
ViewType

ALBPM Process API

© Copyright 1996/2005 Fuego Inc. All Rights Reserved