|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.wst.ws.service.policy.ServicePolicyPlatform
public class ServicePolicyPlatform
This class is used to access and add service policies to the platform.
Method Summary | |
---|---|
void |
addChildChangeListener(IPolicyChildChangeListener listener,
boolean onCommit)
This method allows calls to listener to any child change that is made in the service policy platform regardless of where it is located in the tree of service policies. |
void |
addProjectLoadListener(IPolicyPlatformProjectLoadListener listener)
Add a project platform listener. |
void |
commitChanges()
Calling this method will commit all the state changes that were made to all the service policies. |
void |
commitChanges(org.eclipse.core.resources.IProject project)
Calling this method will commit all the state changes that were made to all the service policies for a particular project. |
IServicePolicy |
createServicePolicy(IServicePolicy parent,
java.lang.String id,
java.lang.String enumListId,
java.lang.String defaultEnumId)
This method creates an IServicePolicy object. |
void |
discardChanges()
Calling this method will discard all the state changes that were made to all the service policies. |
void |
discardChanges(org.eclipse.core.resources.IProject project)
Calling this method will discard all the state changes that were made to all the service policies for a particular project. |
java.util.Set<java.lang.String> |
getAllPolicyIds()
Returns all service policy IDs that are defined. |
static ServicePolicyPlatform |
getInstance()
Returns a singleton instance of this service policy platform. |
java.util.List<IServicePolicy> |
getRootServicePolicies(IFilter filter)
Returns the list of root policies for the platform given a filter. |
IServicePolicy |
getServicePolicy(java.lang.String id)
Returns a service policy given it's unique ID. |
java.util.List<IStateEnumerationItem> |
getStateEnumeration(java.lang.String enumId)
|
IStateEnumerationItem |
getStateItemEnumeration(java.lang.String stateItemId)
|
boolean |
isEnabled(java.lang.Object object)
Indicates if the property page for a project should be displayed in a popup menu or not. |
boolean |
isProjectPreferencesEnabled(org.eclipse.core.resources.IProject project)
Returns if the particular project has been enabled or not on it's service policy property page. |
void |
queueChildChangeListeners(boolean queue)
Indicates whether child change listeners should be queued or not. |
void |
removeChildChangeListener(IPolicyChildChangeListener listener,
boolean onCommit)
Removes a child change listener from the service policy platform. |
void |
removeProjectLoadListener(IPolicyPlatformProjectLoadListener listener)
Removes a project platform listener. |
void |
removeServicePolicy(IServicePolicy policy)
Removes a service policy from the service policy platform. |
void |
restoreDefaults()
Restores the workspace level defaults. |
void |
restoreDefaults(org.eclipse.core.resources.IProject project)
Restores the project level defaults. |
void |
setProjectPreferencesEnabled(org.eclipse.core.resources.IProject project,
boolean value)
Sets whether a project specific service policy preferences is enabled or not. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static ServicePolicyPlatform getInstance()
public boolean isEnabled(java.lang.Object object)
object
-
public void commitChanges()
public void discardChanges()
public void commitChanges(org.eclipse.core.resources.IProject project)
public void discardChanges(org.eclipse.core.resources.IProject project)
public java.util.Set<java.lang.String> getAllPolicyIds()
public java.util.List<IServicePolicy> getRootServicePolicies(IFilter filter)
filter
- a filter a the service policies. This method may be null if
no filter is required.
public IServicePolicy getServicePolicy(java.lang.String id)
id
-
public boolean isProjectPreferencesEnabled(org.eclipse.core.resources.IProject project)
project
-
public void setProjectPreferencesEnabled(org.eclipse.core.resources.IProject project, boolean value)
project
- value
- public void restoreDefaults()
public void restoreDefaults(org.eclipse.core.resources.IProject project)
project
- public IServicePolicy createServicePolicy(IServicePolicy parent, java.lang.String id, java.lang.String enumListId, java.lang.String defaultEnumId)
parent
- the parent policy for this policy. If this policy has no
parent null may be specified.id
- This is a unique id for this service policy. If the id specified
is not unique trailing numerical digits in the id will be stripped off.
Numerical digits will then be added to end of the id to make it unique.
If the id is empty or null the framework will assign a unique id.enumListId
- If this policy's state is defined by an enumeration
the enumeration id should be specified here. Otherwise null should be
specified.defaultEnumId
- If this policy's state is defined by an enumeration
this parameter specifies the default value. This value may be null
if not using an enumeration or if the default value of the enumeration
should be used.
public void removeServicePolicy(IServicePolicy policy)
policy
- the service policypublic void addChildChangeListener(IPolicyChildChangeListener listener, boolean onCommit)
listener
- onCommit
- indicates whether this listener should be invoked when
the the platform changes are committed.public void queueChildChangeListeners(boolean queue)
queue
- public void removeChildChangeListener(IPolicyChildChangeListener listener, boolean onCommit)
listener
- onCommit
- indicates whether this change listener should be removed
from the onCommit list.public void addProjectLoadListener(IPolicyPlatformProjectLoadListener listener)
listener
- the listenerpublic void removeProjectLoadListener(IPolicyPlatformProjectLoadListener listener)
listener
- the listenerpublic java.util.List<IStateEnumerationItem> getStateEnumeration(java.lang.String enumId)
enumId
-
public IStateEnumerationItem getStateItemEnumeration(java.lang.String stateItemId)
stateItemId
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |