com.esri.gpt.control.publication
Class ManageMetadataController

java.lang.Object
  com.esri.gpt.framework.jsf.BaseActionListener
      com.esri.gpt.control.publication.ManageMetadataController

All Implemented Interfaces:

EventListener, ActionListener, FacesListener

public class ManageMetadataController
extends BaseActionListener

Handles actions related to metadata management.

Constructor Summary

ManageMetadataController()
Default constructor.

Method Summary

MmdActionCriteria	getActionCriteria() Gets the action criteria.
boolean	getAlwaysFalse() Returns a false condition in support of the check-all control on the manage metadata page.
SelectableGroups	getCandidateGroups() Gets list of candidate groups
MmdCriteria	getCriteria() Gets the criteria for a manage metadata request.
MetadataAccessPolicy	getMetadataAccessPolicyConfig() Gets access policy configuration
PageCursorPanel	getPageCursorPanel() Gets the panel for displaying the page cursor.
ArrayList<SelectItem>	getProtocols() Gets protocols eligible to choose.
MmdQueryCriteria	getQueryCriteria() Gets the query criteria.
String	getQueryCriteriaAsEncrypedString() Gets query criteria as encrypted string.
MmdQueryResult	getQueryResult() Gets the query result.
int	getRecordsPerPage() Gets the maximum number of records to be displayed per page.
SelectablePublishers	getSelectablePublishers() Gets list of selectable publishers.
boolean	isPolicyUnrestricted() Check if document access policy type is unrestricted
boolean	isSelectableGroups() Checks if is there any selectable group
protected void	onPrepareView(RequestContext context) Fired when the getPrepareView() property is accessed.
protected void	processSubAction(ActionEvent event, RequestContext context) Handles a metadata management action.
void	setAccessPolicyConfig(MetadataAccessPolicy metadataAccessPolicyConfig) Sets access policy configuration.
void	setAlwaysFalse(boolean ignored) Accepts a boolean in support of the check-all control on the manage metadata page.
void	setCandidateGroups(SelectableGroups candidateGroups) Sets list of candidate groups
void	setCriteria(MmdCriteria criteria) Sets the criteria for a manage metadata request.
void	setQueryCriteriaAsEncrypedString(String content) Sets query criteria as encrypted string.
void	setRecordsPerPage(int recordsPerPage) Sets the maximum number of records to be displayed per page.

Methods inherited from class com.esri.gpt.framework.jsf.BaseActionListener

assertLoggedIn, authorizeAction, extractMessageBroker, extractRequestContext, getContextBroker, getKey, getLogger, getNavigationOutcome, getPrepareView, getSecurityRoles, getSecurityRoleSet, handleException, onExecutionPhaseCompleted, onExecutionPhaseStarted, onPrepareViewCompleted, onPrepareViewStarted, processAction, setKey, setNavigationOutcome, setPrepareView, setSecurityRoles

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ManageMetadataController

public ManageMetadataController()

Default constructor.

Method Detail

getCandidateGroups

public SelectableGroups getCandidateGroups()

Gets list of candidate groups

Returns:

the list of candidate groups

setCandidateGroups

public void setCandidateGroups(SelectableGroups candidateGroups)

Sets list of candidate groups

Parameters:

candidateGroups - the list of candidate groups

getMetadataAccessPolicyConfig

public MetadataAccessPolicy getMetadataAccessPolicyConfig()

Gets access policy configuration

Returns:

access policy configuration

setAccessPolicyConfig

public void setAccessPolicyConfig(MetadataAccessPolicy metadataAccessPolicyConfig)

Sets access policy configuration.

Parameters:

metadataAccessPolicyConfig - access policy configuration

getActionCriteria

public MmdActionCriteria getActionCriteria()

Gets the action criteria.

Returns:

the action criteria

getAlwaysFalse

public boolean getAlwaysFalse()

Returns a false condition in support of the check-all control on the manage metadata page.

Returns:

false

setAlwaysFalse

public void setAlwaysFalse(boolean ignored)

Accepts a boolean in support of the check-all control on the manage metadata page.

Parameters:

ignored - this value is ignored (the state of this control is not preserved)

getCriteria

public MmdCriteria getCriteria()

Gets the criteria for a manage metadata request.

Returns:

the criteria

setCriteria

public void setCriteria(MmdCriteria criteria)

Sets the criteria for a manage metadata request.

Parameters:

criteria - the criteria

getPageCursorPanel

public PageCursorPanel getPageCursorPanel()

Gets the panel for displaying the page cursor.

Returns:

the page cursor panel

getQueryCriteria

public MmdQueryCriteria getQueryCriteria()

Gets the query criteria.

Returns:

the query criteria

getQueryResult

public MmdQueryResult getQueryResult()

Gets the query result.

Returns:

the query result

getRecordsPerPage

public int getRecordsPerPage()

Gets the maximum number of records to be displayed per page.

Returns:

the maximum number of records per page

setRecordsPerPage

public void setRecordsPerPage(int recordsPerPage)

Sets the maximum number of records to be displayed per page.

Parameters:

recordsPerPage - the maximum number of records per page

getSelectablePublishers

public SelectablePublishers getSelectablePublishers()

Gets list of selectable publishers.

Returns:

the list of selectable publishers

isPolicyUnrestricted

public boolean isPolicyUnrestricted()

Check if document access policy type is unrestricted

Returns:

true if policy is unrestricted

onPrepareView

protected void onPrepareView(RequestContext context)
                      throws Exception

Fired when the getPrepareView() property is accessed.
This event is triggered from the page during the render response phase of the JSF cycle.

The UI components associated with the PageCursorPanel are build on the firing of this event.

Overrides:

onPrepareView in class BaseActionListener

Parameters:

context - the context associated with the active request

Throws:

Exception - if an exception occurs

isSelectableGroups

public boolean isSelectableGroups()

Checks if is there any selectable group

Returns:

true if is there at leas one selectable group present

getQueryCriteriaAsEncrypedString

public String getQueryCriteriaAsEncrypedString()

Gets query criteria as encrypted string. Gets data from the last search criteria invoked.

Returns:

query criteria as encrypted string

setQueryCriteriaAsEncrypedString

public void setQueryCriteriaAsEncrypedString(String content)

Sets query criteria as encrypted string. Instead overwriting query criteria for search, stores data in a separate object.

Parameters:

content - query criteria as encrypted string

getProtocols

public ArrayList<SelectItem> getProtocols()

Gets protocols eligible to choose.

Returns:

collection of protocols eligible to choose

processSubAction

protected void processSubAction(ActionEvent event,
                                RequestContext context)
                         throws AbortProcessingException,
                                Exception

Handles a metadata management action.
This is the default entry point for a sub-class of BaseActionListener.
This BaseActionListener handles the JSF processAction method and invokes the processSubAction method of the sub-class.

Overrides:

processSubAction in class BaseActionListener

Parameters:

event - the associated JSF action event

context - the context associated with the active request

Throws:

AbortProcessingException - if processing should be aborted

Exception - if an exception occurs