Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle WebCenter
11g Release 1 (11.1.1.3.0)
E15995-02


oracle.webcenter.page.model
Class PageServiceScopeAPI

java.lang.Object
  extended by oracle.webcenter.page.model.PageServiceScopeAPI


public class PageServiceScopeAPI
extends java.lang.Object

Constructor Summary
PageServiceScopeAPI()
           

 

Method Summary
 void copy(Scope source, Scope target)
          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(Scope scope)
          Get whether the Service has been provisioned for the supplied Scope.
 boolean isReadOnly(Scope scope)
          Get whether the Service is read only for the the supplied Scope.
 void provision(Scope scope, java.lang.String scopeDisplayName)
          Make the Service available in the supplied Scope by seeding any metadata and data.
 void rename(Scope source, Scope target)
          Change the name of a Scope used by the Service.
 void setReadOnly(Scope scope, boolean readOnly)
          Set whether the Service is read only within the supplied Scope.
 void unprovision(Scope scope)
          Makes a Service unavailable in the supplied Scope by removing all data and metadata.

 

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(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(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(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(Scope source,
                 Scope target)
          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(Scope source,
                   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(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(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()

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle WebCenter
11g Release 1 (11.1.1.3.0)
E15995-02


Copyright © 2009, 2010, Oracle. All rights reserved.