org.nuxeo.ecm.platform.archive.web.listener
Interface ArchiveManagerActions

All Superinterfaces:

Serializable

All Known Subinterfaces:

ArchiveManagerActionsLocal, ArchiveManagerActionsRemote

All Known Implementing Classes:

ArchiveManagerActionsBean

public interface ArchiveManagerActions
extends Serializable

Archive manager actions business interface.

Author:

Bogdan Tatar

Method Summary

String	addArchiveRecord() Adds a new archive record.
String	cancel() Cancels the process of adding or editing an archive record.
void	computeArchiveRecords() Computes all archive records.
String	deleteArchiveRecord() Deletes an archive record.
void	destroy()
String	editArchiveRecord() Edits an archive record.
String	getCommandName1() Sets the first button command name from the page used to add/edit an archive record.
String	getCommandName2() Sets the second button command name from the page used to add/edit an archive record.
List<SelectItem>	getDocumentVersions() Returns a list of SelectItems with the versions of the current document.
boolean	getEditable() Checks if the page used to add/edit an archive record is editable.
boolean	getRequired() This method is used to mark the fields that are required to be given a value when an archive record is created.This method is mostly used in the xhtml for an archive record.
ArchiveRecord	getSelectedArchiveRecord() Returns the archive record to add/edit.
boolean	getShowCreateForm() Tells if the "add new archive" record button should appear or not.
String	getStyle() Returns the style of the components that appear in the add/edit archive record page.
void	invalidateArchiveRecords() Invalidates archive records.
void	setCommandName1(String commandName) Sets the first command button name.
void	setCommandName2(String commandName) Sets the second command button name.
void	setEditable(boolean editable) Sets the page for add/edit archive record as editable or not.
void	setRequired(ActionEvent event) This method is used when the cancel button on the page that is used to add an archive recod, is clicked.This way the user is not asked to give values for the fields that needs to have a value.The 'event' parameter is introduced in the signature of the method in order to be use this method as an 'actionListener' for the 'h:commandButton' tag
void	setSelectedArchiveRecord(ArchiveRecord selectedArchiveRecord) Sets the archive record to add/edit.
void	setStyle(String style) Sets the style of the components that appear in the add/edit archive record page.
void	toggleCreateForm(ActionEvent event) Used to decide if the add new archive record button should appear or not.
String	viewArchiveRecord() Views an archive record.

Method Detail

invalidateArchiveRecords

void invalidateArchiveRecords()
                              throws Exception

Invalidates archive records.

Throws:

Exception

computeArchiveRecords

void computeArchiveRecords()
                           throws Exception

Computes all archive records.

Throws:

Exception

Factory:

See Also:

addArchiveRecord

String addArchiveRecord()
                        throws Exception

Adds a new archive record.

Returns:

where to forward to after the archive record is added

Throws:

Exception

editArchiveRecord

String editArchiveRecord()
                         throws Exception

Edits an archive record.

Returns:

where to forward to after the archive record is modified

Throws:

Exception

viewArchiveRecord

String viewArchiveRecord()
                         throws Exception

Views an archive record.

Returns:

where to forward to after the archive record is viewed

Throws:

Exception

deleteArchiveRecord

String deleteArchiveRecord()
                           throws Exception

Deletes an archive record.

Returns:

where to forward to after the archive record is deleted

Throws:

Exception

toggleCreateForm

void toggleCreateForm(ActionEvent event)

Used to decide if the add new archive record button should appear or not. The 'event' parameter is not used in the implementation of the method, and it had to be included in the signature of the method in order to accomodate the jsf specification for an 'actionListener' method added to an 'h:commandLink' tag.

getShowCreateForm

boolean getShowCreateForm()

Tells if the "add new archive" record button should appear or not.

Returns:

true if the "add new archive" record button should appear, false otherwise.

getRequired

boolean getRequired()

This method is used to mark the fields that are required to be given a value when an archive record is created.This method is mostly used in the xhtml for an archive record.

Returns:

true - if the field needs to have a value false- otherwise

setRequired

void setRequired(ActionEvent event)

This method is used when the cancel button on the page that is used to add an archive recod, is clicked.This way the user is not asked to give values for the fields that needs to have a value.The 'event' parameter is introduced in the signature of the method in order to be use this method as an 'actionListener' for the 'h:commandButton' tag

Parameters:

event -

destroy

@Destroy
void destroy()

getDocumentVersions

List<SelectItem> getDocumentVersions()
                                     throws Exception

Returns a list of SelectItems with the versions of the current document.

Returns:

a list of SelectItems with the versions of the current document

Throws:

Exception

getSelectedArchiveRecord

ArchiveRecord getSelectedArchiveRecord()

Returns the archive record to add/edit.

Returns:

the archive record to add/edit

setSelectedArchiveRecord

void setSelectedArchiveRecord(ArchiveRecord selectedArchiveRecord)

Sets the archive record to add/edit.

Parameters:

selectedArchiveRecord -

cancel

String cancel()
              throws Exception

Cancels the process of adding or editing an archive record.

Returns:

where to forward to after canceling

Throws:

Exception

getCommandName1

String getCommandName1()

Sets the first button command name from the page used to add/edit an archive record.

Returns:

- the name of the command button

setCommandName1

void setCommandName1(String commandName)

Sets the first command button name.

Parameters:

commandName - - the name of the command button

getCommandName2

String getCommandName2()

Sets the second button command name from the page used to add/edit an archive record.

Returns:

- the name of the command button

setCommandName2

void setCommandName2(String commandName)

Sets the second command button name.

Parameters:

commandName - - the name of the command button

getEditable

boolean getEditable()

Checks if the page used to add/edit an archive record is editable.

Returns:

- true if the page is editable

- false otherwise

setEditable

void setEditable(boolean editable)

Sets the page for add/edit archive record as editable or not.

Parameters:

editable - - if true then the page is editable

getStyle

String getStyle()

Returns the style of the components that appear in the add/edit archive record page.

Returns:

- the style used for the components of the page

setStyle

void setStyle(String style)

Sets the style of the components that appear in the add/edit archive record page.

Parameters:

style - - the style used for the components of the page