---

getState schedule

Returns the current state of a schedule as an XML document.

See Also

getAllStates schedule
getStateList schedule

Syntax

getState schedule --NAME=object_name [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=state_properties]

or

getState schedule -n object_name [-o output_file] [-l state_properties]

Parameters

object_name

Content of a <search:name> element in the XML document.

output_file

Name of a file in which the exported XML document is stored. You can specify a simple file name, a relative path, or a fully qualified path. When executing on multiple instances, the getState command creates a separate file for each one and appends the host name and port number to the base name.

state_properties

One or more of these state properties: lastCrawled, logFilePath, nextCrawl, scheduleError, and status. Separate multiple properties with commas. All state properties are returned by default.

Example

This example directs a schedule to a file named mailing_schedule.xml. The XML shows that the current status of the schedule is disabled.

SES>getState schedule --NAME="Mailing List Schedule" --OUTPUT_FILE=mailing_schedule.xml
 
The getState operation succeeded.

$ more mailing_schedule.xml
<?xml version="1.0" encoding="UTF-8"?>
<search:state productVersion="11.1.2.2.0" xmlns:search="http://xmlns.oracle.com/
search">
   <search:objectStates>
      <search:objectState>
         <search:objectType>schedule</search:objectType>
         <search:objectKey>
            <search:keyPairs>
               <search:keyPair>
                  <search:name>name</search:name>
                  <search:value>Mailing list Schedule</search:value>
               </search:keyPair>
            </search:keyPairs>
         </search:objectKey>
         <search:stateProperties>
            <search:stateProperty>
               <search:propertyName>status</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:value>DISABLED</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
         </search:stateProperties>
      </search:objectState>
   </search:objectStates>