org.lockss.ws.control

Interface AuControlService

All Known Implementing Classes:

AuControlServiceImpl

public interface AuControlService

The AU Control SOAP web service interface.

Method Summary

Modifier and Type	Method and Description
CheckSubstanceResult	checkSubstanceById(String auId) Provides an indication of whether an archival unit has substance.
List<CheckSubstanceResult>	checkSubstanceByIdList(List<String> auIds) Provides an indication of whether the archival units defined by a list with their identifiers have substance.
RequestAuControlResult	disableMdIndexingById(String auId) Disables the metadata indexing of an archival unit.
List<RequestAuControlResult>	disableMdIndexingByIdList(List<String> auIds) Disables the metadata indexing of the archival units defined by a list with their identifiers.
RequestAuControlResult	enableMdIndexingById(String auId) Enables the metadata indexing of an archival unit.
List<RequestAuControlResult>	enableMdIndexingByIdList(List<String> auIds) Enables the metadata indexing of the archival units defined by a list with their identifiers.
RequestCrawlResult	requestCrawlById(String auId, Integer priority, boolean force) Requests the crawl of an archival unit.
List<RequestCrawlResult>	requestCrawlByIdList(List<String> auIds, Integer priority, boolean force) Requests the crawl of the archival units defined by a list with their identifiers.
RequestDeepCrawlResult	requestDeepCrawlById(String auId, int refetchDepth, Integer priority, boolean force) Requests the deep crawl of an archival unit.
List<RequestDeepCrawlResult>	requestDeepCrawlByIdList(List<String> auIds, int refetchDepth, Integer priority, boolean force) Requests the deep crawl of the archival units defined by a list with their identifiers.
RequestAuControlResult	requestMdIndexingById(String auId, boolean force) Requests the metadata indexing of an archival unit.
List<RequestAuControlResult>	requestMdIndexingByIdList(List<String> auIds, boolean force) Requests the metadata indexing of the archival units defined by a list with their identifiers.
RequestAuControlResult	requestPollById(String auId) Requests the polling of an archival unit.
List<RequestAuControlResult>	requestPollByIdList(List<String> auIds) Requests the polling of the archival units defined by a list with their identifiers.

Method Detail

checkSubstanceById

CheckSubstanceResult checkSubstanceById(String auId)
                                 throws LockssWebServicesFault

Provides an indication of whether an archival unit has substance.

Parameters:

auId - A String with the identifier (auid) of the archival unit.

Returns:

a CheckSubstanceResult with the result of the operation.

Throws:

LockssWebServicesFault - if there are problems.

checkSubstanceByIdList

List<CheckSubstanceResult> checkSubstanceByIdList(List<String> auIds)
                                           throws LockssWebServicesFault

Provides an indication of whether the archival units defined by a list with their identifiers have substance.

Parameters:

auIds - A List<String> with the identifiers (auids) of the archival units.

Returns:

a List<CheckSubstanceResult> with the results of the operation.

Throws:

LockssWebServicesFault - if there are problems.

requestCrawlById

RequestCrawlResult requestCrawlById(String auId,
                                    Integer priority,
                                    boolean force)
                             throws LockssWebServicesFault

Requests the crawl of an archival unit.

Parameters:

auId - A String with the identifier (auid) of the archival unit.

priority - An Integer with the priority of the crawl request.

force - A boolean with true if the request is to be made even in the presence of some anomalies, false otherwise.

Returns:

a RequestCrawlResult with the result of the operation.

Throws:

LockssWebServicesFault - if there are problems.

requestCrawlByIdList

List<RequestCrawlResult> requestCrawlByIdList(List<String> auIds,
                                              Integer priority,
                                              boolean force)
                                       throws LockssWebServicesFault

Requests the crawl of the archival units defined by a list with their identifiers.

Parameters:

auIds - A List<String> with the identifiers (auids) of the archival units.

priority - An Integer with the priority of the crawl request.

force - A boolean with true if the request is to be made even in the presence of some anomalies, false otherwise.

Returns:

a List<RequestCrawlResult> with the results of the operation.

Throws:

LockssWebServicesFault - if there are problems.

requestDeepCrawlById

RequestDeepCrawlResult requestDeepCrawlById(String auId,
                                            int refetchDepth,
                                            Integer priority,
                                            boolean force)
                                     throws LockssWebServicesFault

Requests the deep crawl of an archival unit.

Parameters:

auId - A String with the identifier (auid) of the archival unit.

refetchDepth - An int with the depth of the crawl request.

priority - An Integer with the priority of the crawl request.

force - A boolean with true if the request is to be made even in the presence of some anomalies, false otherwise.

Returns:

a RequestDeepCrawlResult with the result of the operation.

Throws:

LockssWebServicesFault - if there are problems.

requestDeepCrawlByIdList

List<RequestDeepCrawlResult> requestDeepCrawlByIdList(List<String> auIds,
                                                      int refetchDepth,
                                                      Integer priority,
                                                      boolean force)
                                               throws LockssWebServicesFault

Requests the deep crawl of the archival units defined by a list with their identifiers.

Parameters:

auIds - A List<String> with the identifiers (auids) of the archival units.

refetchDepth - An int with the depth of the crawl request.

priority - An Integer with the priority of the crawl request.

force - A boolean with true if the request is to be made even in the presence of some anomalies, false otherwise.

Returns:

a List<RequestDeepCrawlResult> with the results of the operation.

Throws:

LockssWebServicesFault - if there are problems.

requestPollById

RequestAuControlResult requestPollById(String auId)
                                throws LockssWebServicesFault

Requests the polling of an archival unit.

Parameters:

auId - A String with the identifier (auid) of the archival unit.

Returns:

a RequestAuControlResult with the result of the operation.

Throws:

LockssWebServicesFault - if there are problems.

requestPollByIdList

List<RequestAuControlResult> requestPollByIdList(List<String> auIds)
                                          throws LockssWebServicesFault

Requests the polling of the archival units defined by a list with their identifiers.

Parameters:

auIds - A List<String> with the identifiers (auids) of the archival units.

Returns:

a List<RequestAuControlResult> with the results of the operation.

Throws:

LockssWebServicesFault - if there are problems.

requestMdIndexingById

RequestAuControlResult requestMdIndexingById(String auId,
                                             boolean force)
                                      throws LockssWebServicesFault

Requests the metadata indexing of an archival unit.

Parameters:

auId - A String with the identifier (auid) of the archival unit.

force - A boolean with true if the request is to be made even in the presence of some anomalies, false otherwise.

Returns:

a RequestAuControlResult with the result of the operation.

Throws:

LockssWebServicesFault - if there are problems.

requestMdIndexingByIdList

List<RequestAuControlResult> requestMdIndexingByIdList(List<String> auIds,
                                                       boolean force)
                                                throws LockssWebServicesFault

Requests the metadata indexing of the archival units defined by a list with their identifiers.

Parameters:

auIds - A List with the identifiers (auids) of the archival units.

force - A boolean with true if the request is to be made even in the presence of some anomalies, false otherwise.

Returns:

a List with the results of the operation.

Throws:

LockssWebServicesFault - if there are problems.

disableMdIndexingById

RequestAuControlResult disableMdIndexingById(String auId)
                                      throws LockssWebServicesFault

Disables the metadata indexing of an archival unit.

Parameters:

auId - A String with the identifier (auid) of the archival unit.

Returns:

a RequestAuControlResult with the result of the operation.

Throws:

LockssWebServicesFault - if there are problems.

disableMdIndexingByIdList

List<RequestAuControlResult> disableMdIndexingByIdList(List<String> auIds)
                                                throws LockssWebServicesFault

Disables the metadata indexing of the archival units defined by a list with their identifiers.

Parameters:

auIds - A List with the identifiers (auids) of the archival units.

Returns:

a List with the results of the operation.

Throws:

LockssWebServicesFault - if there are problems.

enableMdIndexingById

RequestAuControlResult enableMdIndexingById(String auId)
                                     throws LockssWebServicesFault

Enables the metadata indexing of an archival unit.

Parameters:

auId - A String with the identifier (auid) of the archival unit.

Returns:

a RequestAuControlResult with the result of the operation.

Throws:

LockssWebServicesFault - if there are problems.

enableMdIndexingByIdList

List<RequestAuControlResult> enableMdIndexingByIdList(List<String> auIds)
                                               throws LockssWebServicesFault

Enables the metadata indexing of the archival units defined by a list with their identifiers.

Parameters:

auIds - A List with the identifiers (auids) of the archival units.

Returns:

a List with the results of the operation.

Throws:

LockssWebServicesFault - if there are problems.