fuego.papi
Interface EditableView

All Superinterfaces:

Serializable, View

All Known Subinterfaces:

EditableActivityView, EditableApplicationsView, EditableAttachmentsView, EditableBookmarkView, EditableConsultationsView, EditableFolderView, EditableHistoryView, EditableInstancesView

public interface EditableView

extends View

This View can be modified, if it is needed a read-only View use View instead. Handle different kind of information using presentations.
There are three different kind of EditableViews, depending on the information to be presented. Editable Views for Instances, Editable Views for Applications and Editable Views for Attachments, each one has its own presentation type. To obtain an EditableView from a View, you can call the method ProcessServiceNESession.getEditableView(View) with the View as an argument.

To store a modified View, get the ProcessServiceSession and call the method ProcessServiceSession.storeView(View).

i.e.

  String[] viewIds = processServiceSession.getViewIds();
  for (int i=0; i < viewIds.length; i++) {
     View view = processServiceSession.getView(viewIds[i]);
     EditableView editView = processServiceSession.getEditableView(view);
     editView.setLabel("View Number " + i, java.util.Locale.ENGLISH);
     processServiceSession.storeView(editView);
  }

  EditableView editView = processServiceSession.createView(ViewType.INSTANCES, "MyViewID",
                                             new String[] {"DeployedProcessVersion" });

Field Summary

Fields inherited from interface fuego.papi.View

APPLICATIONS_DEFAUTL_ID, ATTACHMENTS_DEFAULT_ID, BOOKMARK_DEFAULT_ID, CONSULTATIONS_DEFAUTL_ID, DEFAULT_OWNER, HISTORY_DEFAUTL_ID, HISTORY_TODAY_DEFAULT_ID, INBOX_DEFAULT_ID

Method Summary

void	assignProcess(String processId) Assign a process identification
void	assignProcesses(String[] processIds) Assign more than one process identification.
void	assignRole(String roleId) Assign a role
void	assignRoles(String[] roleIds) Assign more than one role
void	clearLabels() Remove all labels assigned.
String	removeLabel(Locale locale) Remove the label for the given specific locale.
void	setCustom(boolean isCustom) Sets this View as custom or default.
void	setHidden(boolean isHidden) Sets this View as hidden or vissible.
void	setLabel(String label, Locale locale) Sets a lable for a specific locale
void	setPresentation(String presentationId) Sets the presentation id for this view
void	setReadOnly(boolean isReadOnly) Sets the read-only status for everyone but the owner.
void	unassignAllProcesses() Unassign all assigned process
void	unassignAllRoles() Unassign all assigned roles
void	unassignProcess(String processId) Unassign a specific assigned process
void	unassignRole(String roleId) Unassign a specific assigned role

Methods inherited from interface fuego.papi.View

getAssignedProcesses, getAssignedRoles, getId, getLabel, getOwner, getParentId, getPresentation, getPresentationType, getType, hasType, isCustom, isHidden, isReadOnly, isTransient

Method Detail

setCustom

public void setCustom(boolean isCustom)

Sets this View as custom or default.

Parameters:

isCustom - true to set it as a custom View.

setHidden

public void setHidden(boolean isHidden)

Sets this View as hidden or vissible.

Parameters:

isHidden - true to set it as a hidden View.

setLabel

public void setLabel(String label,
                     Locale locale)

Sets a lable for a specific locale

Parameters:

label - label to be shown as the "folder" name

locale - the desired locale.

setPresentation

public void setPresentation(String presentationId)

Sets the presentation id for this view

Parameters:

presentationId - presentation identification

setReadOnly

public void setReadOnly(boolean isReadOnly)

Sets the read-only status for everyone but the owner. If read-only is "on", this View will not allow to ask for the EditableView to anyone else but the owner.

Parameters:

isReadOnly - set the desired View status.

assignProcess

public void assignProcess(String processId)

Assign a process identification

Parameters:

processId - process identification

assignProcesses

public void assignProcesses(String[] processIds)

Assign more than one process identification.

Parameters:

processIds - array of processes identification

assignRole

public void assignRole(String roleId)

Assign a role

Parameters:

roleId - role identification

assignRoles

public void assignRoles(String[] roleIds)

Assign more than one role

Parameters:

roleIds - array of roles identification

clearLabels

public void clearLabels()

Remove all labels assigned.

removeLabel

public String removeLabel(Locale locale)

Remove the label for the given specific locale.

Parameters:

locale - the desired Locale

Returns:

the removed label or null when no label exists for that locale

unassignAllProcesses

public void unassignAllProcesses()

Unassign all assigned process

unassignAllRoles

public void unassignAllRoles()

Unassign all assigned roles

unassignProcess

public void unassignProcess(String processId)

Unassign a specific assigned process

Parameters:

processId - process identification

unassignRole

public void unassignRole(String roleId)

Unassign a specific assigned role

Parameters:

roleId - role identification