ALBPM Process API (PAPI)

fuego.papi
Interface Presentation

All Superinterfaces:
Serializable
All Known Subinterfaces:
EditablePresentation

public interface Presentation
extends Serializable

Used to define the columns displayed in a View.


Nested Class Summary
static class Presentation.Column
          Column contains every attribute for a column, the main idea is to get and keep all the neccesary info, like size and id, etc.
static class Presentation.DefaultPresentationColumnFormat
          The default PresentationColumnFormat.
 
Field Summary
static String DEFAULT_ACTIVITY_ID
          Id of the default activity view presentation.
static String DEFAULT_APPLICATIONS_ID
          Id of the default applications view presentation.
static String DEFAULT_ATTACHMENTS_ID
          Id of the default attachments view presentation.
static String DEFAULT_FOLDER_ID
          Id of the default folder view presentation.
static String DEFAULT_ID
          Id of the default presentation.
static String DEFAULT_INSTANCES_ID
          Id of the default instances view presentation.
static String DEFAULT_OWNER
          Id of the default owner.
 
Method Summary
 Presentation copy(String newPresentationId)
          Retuns a new Presentation which is a copy of this instance of Presentation with the specified Id.
 Presentation.Column[] getColumns()
          Gets the columns of this presentation.
 String getId()
          Gets the Id of the presentation.
 Ordering getOrdering()
          Gets the columns which will be use to sort this presentation.
 String getOwner()
          Gets the owner of the presentation.
 PresentationType getType()
          Gets the type of the presentation.
 boolean isReadOnly()
          Returns if this presentation is read only.
 void setOrdering(Ordering ordering)
          Sets the colums which will be use to sort this presentation.
 

Field Detail

DEFAULT_ACTIVITY_ID

public static final String DEFAULT_ACTIVITY_ID
Id of the default activity view presentation.

See Also:
Constant Field Values

DEFAULT_APPLICATIONS_ID

public static final String DEFAULT_APPLICATIONS_ID
Id of the default applications view presentation.

See Also:
Constant Field Values

DEFAULT_ATTACHMENTS_ID

public static final String DEFAULT_ATTACHMENTS_ID
Id of the default attachments view presentation.

See Also:
Constant Field Values

DEFAULT_FOLDER_ID

public static final String DEFAULT_FOLDER_ID
Id of the default folder view presentation.

See Also:
Constant Field Values

DEFAULT_ID

public static final String DEFAULT_ID
Id of the default presentation.

See Also:
Constant Field Values

DEFAULT_INSTANCES_ID

public static final String DEFAULT_INSTANCES_ID
Id of the default instances view presentation.

See Also:
Constant Field Values

DEFAULT_OWNER

public static final String DEFAULT_OWNER
Id of the default owner.

See Also:
Constant Field Values
Method Detail

getColumns

public Presentation.Column[] getColumns()
Gets the columns of this presentation.

Returns:
columns of this presentation.

getId

public String getId()
Gets the Id of the presentation.

Returns:
Id of the presentation.

getOwner

public String getOwner()
Gets the owner of the presentation.

The owner of the presentation is the participant whos create the presentation.

Returns:
owner of the presentation.

isReadOnly

public boolean isReadOnly()
Returns if this presentation is read only.

Returns:
true if this presentation is read only.

getType

public PresentationType getType()
Gets the type of the presentation.

Returns:
the PresentationType of the presentation.
See Also:
PresentationType

copy

public Presentation copy(String newPresentationId)
Retuns a new Presentation which is a copy of this instance of Presentation with the specified Id.

Parameters:
newPresentationId - Id of the new presentation.
Returns:
new Presentation object.

setOrdering

public void setOrdering(Ordering ordering)
Sets the colums which will be use to sort this presentation.

Parameters:
ordering - Ordering which contains the columns to sort.

getOrdering

public Ordering getOrdering()
Gets the columns which will be use to sort this presentation.

Returns:
Ordering which contains the columns to sort.

ALBPM Process API (PAPI)

© Copyright 1996/2005 Fuego Inc. All Rights Reserved