oracle.webcenter.page.model

Class PageServiceScopeAPI

java.lang.Object

oracle.webcenter.page.model.PageServiceScopeAPI

public class PageServiceScopeAPI
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
PageServiceScopeAPI()

Method Summary

Modifier and Type	Method and Description
void	copy(oracle.webcenter.framework.service.Scope source, oracle.webcenter.framework.service.Scope target, CopyOptions options) Copy all the information stored for a Service in the source Scope to the target Scope this includes all metadata and data with necessary updates made to reflect the target Scope.
boolean	isConfigured()
boolean	isProvisioned(oracle.webcenter.framework.service.Scope scope) Get whether the Service has been provisioned for the supplied Scope.
boolean	isReadOnly(oracle.webcenter.framework.service.Scope scope) Get whether the Service is read only for the the supplied Scope.
void	provision(oracle.webcenter.framework.service.Scope scope, java.lang.String scopeDisplayName) Make the Service available in the supplied Scope by seeding any metadata and data.
void	rename(oracle.webcenter.framework.service.Scope source, oracle.webcenter.framework.service.Scope target) Change the name of a Scope used by the Service.
void	setReadOnly(oracle.webcenter.framework.service.Scope scope, boolean readOnly) Set whether the Service is read only within the supplied Scope.
void	unprovision(oracle.webcenter.framework.service.Scope scope) Makes a Service unavailable in the supplied Scope by removing all data and metadata.
void	updateSecurityHierarchy(oracle.webcenter.framework.service.Scope scope, java.util.Collection<oracle.webcenter.framework.service.Scope> children)

Methods inherited from class java.lang.Object

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

Constructor Detail

PageServiceScopeAPI

public PageServiceScopeAPI()

Method Detail

provision

public void provision(oracle.webcenter.framework.service.Scope scope,
                      java.lang.String scopeDisplayName)
               throws CommandException

Make the Service available in the supplied Scope by seeding any metadata and data. Metadata is seeded before data to ensure that on re-entry the API can discover what data needs still to be created.

Parameters:

scope - Scope to provision the Service for

scopeDisplayName - the display used for the Scope

Throws:

CommandException

unprovision

public void unprovision(oracle.webcenter.framework.service.Scope scope)
                 throws CommandException

Makes a Service unavailable in the supplied Scope by removing all data and metadata. Data is removed before metadata to ensure that on re-entry the API knows what data needs still to be removed.

Parameters:

scope - Scope to unprovision the Service for

Throws:

CommandException

isProvisioned

public boolean isProvisioned(oracle.webcenter.framework.service.Scope scope)
                      throws CommandException

Get whether the Service has been provisioned for the supplied Scope.

Parameters:

scope - the Scope to check if the Service is provisioned for

Returns:

true if the Service is provisioned; false otherwise

Throws:

CommandException

copy

public void copy(oracle.webcenter.framework.service.Scope source,
                 oracle.webcenter.framework.service.Scope target,
                 CopyOptions options)
          throws CommandException

Copy all the information stored for a Service in the source Scope to the target Scope this includes all metadata and data with necessary updates made to reflect the target Scope. As the source data and metadata are maintained order is not important.

Parameters:

source - the source Scope

target - the target Scope

Throws:

CommandException

rename

public void rename(oracle.webcenter.framework.service.Scope source,
                   oracle.webcenter.framework.service.Scope target)
            throws CommandException

Change the name of a Scope used by the Service.

Parameters:

source - the source Scope

target - the target Scope

Throws:

CommandException

setReadOnly

public void setReadOnly(oracle.webcenter.framework.service.Scope scope,
                        boolean readOnly)
                 throws CommandException

Set whether the Service is read only within the supplied Scope. This information is persisted so that the read only state is restored in the event of failure and is reflected on all nodes in a cluster.

Parameters:

scope - Scope to set read only state of Service for

readOnly - true to make the Service read only for the Scope; false otherwise

Throws:

CommandException

isReadOnly

public boolean isReadOnly(oracle.webcenter.framework.service.Scope scope)
                   throws CommandException

Get whether the Service is read only for the the supplied Scope.

Parameters:

scope - Scope to get read only state of Service for

Returns:

true to make the Service read only for the Scope; false otherwise

Throws:

CommandException

isConfigured

public boolean isConfigured()

updateSecurityHierarchy

public void updateSecurityHierarchy(oracle.webcenter.framework.service.Scope scope,
                                    java.util.Collection<oracle.webcenter.framework.service.Scope> children)
                             throws CommandException

Throws:

CommandException