Esri Geoportal Server
1.0

com.esri.gpt.catalog.management
Class MmdActionRequest

java.lang.Object
  extended by com.esri.gpt.framework.sql.BaseDao
      extended by com.esri.gpt.framework.request.DaoRequest<RequestDefinition<MmdCriteria,MmdResult>>
          extended by com.esri.gpt.catalog.management.MmdRequest
              extended by com.esri.gpt.catalog.management.MmdActionRequest
All Implemented Interfaces:
IRequest<RequestDefinition<MmdCriteria,MmdResult>>

public class MmdActionRequest
extends MmdRequest

Executes metadata management actions.

Actions keys:

  • setPosted = Set as Posted
  • setApproved = Set as Approved
  • setIncomplete = Set as Incomplete
  • setDisapproved = Set as Disapproved
  • setReviewed = Set as Reviewed
  • transfer = Transfer Ownership
  • delete = Delete

  • Constructor Summary
    MmdActionRequest(RequestContext requestContext, Publisher publisher, MmdCriteria criteria, MmdResult result)
              Construct a metadata management query request.
     
    Method Summary
     void execute()
              Executes the action request.
     void execute(MmdQueryCriteria queryCriteria)
              Executes request for all records matching given query criteria.
     boolean getApplyToAll()
              Gets flag if apply action to all records.
     boolean hadUnalteredDraftDocuments()
              Gets the status indicating whether or not documents in draft mode were unaltered by an update.
     void setApplyToAll(boolean applyToAll)
              Sets flag if apply action to all records.
     
    Methods inherited from class com.esri.gpt.catalog.management.MmdRequest
    getActionCriteria, getActionResult, getPublisher, getQueryCriteria, getQueryResult, getResourceTableName
     
    Methods inherited from class com.esri.gpt.framework.request.DaoRequest
    getRequestDefinition, setRequestDefinition
     
    Methods inherited from class com.esri.gpt.framework.sql.BaseDao
    appendExpression, appendValueFilter, closeResultSet, closeStatement, getApplicationConfiguration, getRequestContext, logExpression, returnConnection, setRequestContext
     
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
     

    Constructor Detail

    MmdActionRequest

    public MmdActionRequest(RequestContext requestContext,
                            Publisher publisher,
                            MmdCriteria criteria,
                            MmdResult result)
    Construct a metadata management query request.

    Parameters:
    requestContext - the request context
    publisher - the publisher
    criteria - the request criteria
    result - the request result
    Method Detail

    hadUnalteredDraftDocuments

    public boolean hadUnalteredDraftDocuments()
    Gets the status indicating whether or not documents in draft mode were unaltered by an update.
    The approval status of a document in draft mode can only be altered by publishing the document from the online editor.

    Returns:
    true if draft documents were unaltered

    getApplyToAll

    public boolean getApplyToAll()
    Gets flag if apply action to all records.

    Returns:
    flag if apply action to all records

    setApplyToAll

    public void setApplyToAll(boolean applyToAll)
    Sets flag if apply action to all records.

    Parameters:
    applyToAll - flag if apply action to all records

    execute

    public void execute()
                 throws Exception
    Executes the action request.

    Throws:
    ImsServiceException - in an exception occurs while communication with the ArcIMS metadata publishing service
    Exception - if an exception occurs

    execute

    public void execute(MmdQueryCriteria queryCriteria)
                 throws Exception
    Executes request for all records matching given query criteria.

    Parameters:
    queryCriteria - query criteria
    Throws:
    Exception - if executing request fails

    Esri Geoportal Server
    1.0

    Copyright 2011 Environmental Systems Research Institute. All rights reserved. Use is subject to license terms.