|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface ILogicalResource
Logical resources represent z/OS projects and the artifacts that have been
added to them. A logical resource can represent a logical grouping of
resources, or it can refer to a physical resource (represented by an
IPhysicalResource). Multiple logical resources can refer to the same
physical resource. Methods of a logical resource object typically invoke
related methods of the physical resource it refers to.
| Field Summary | |
|---|---|
static String |
COPY_RIGHT
|
| Method Summary | |
|---|---|
void |
delete(boolean force,
IProgressMonitor monitor)
Deletes this resource. |
void |
deleteOverriddenPropertiesInCategory(ICategory category)
Deletes the overridden properties for the given category for the current property group of this resource. |
void |
deleteOverride(IProperty property)
Deletes the override for the given property. |
IPropertyGroup |
getCurrentPropertyGroup()
Returns the current property group for the resource. |
IPath |
getFullPath()
Returns the full path of the resource. |
ILogicalContainer |
getLogicalParent()
Returns the parent of this resource. |
String |
getName()
Returns the name of the resource. |
List |
getOverriddenProperties()
Returns the overridden properties for this resource. |
String |
getPersistentProperty(String key)
Returns the value of a persistent property of this resource. |
IPhysicalResource |
getPhysicalResource()
Returns the physical resource which this logical resource represents. |
IResourcePublisher |
getResourcePublisher()
Returns the resource publisher that manages subscriptions for this logical resource. |
Object |
getSessionProperty(QualifiedName key)
Returns the value of a session property of this resource. |
ILogicalSubProject |
getSubProject()
Convenience method which returns the containing subproject |
void |
refresh(int depth,
IProgressMonitor monitor)
Refreshes this resource to reflect the true state of the file system. |
void |
remove()
Removes this resource (and all its children) from its container. |
void |
rename(String newName)
Renames this resource. |
void |
setCurrentPropertyGroup(IPropertyGroup propertyGroup)
Sets the current property group for the resource. |
void |
setOverride(IProperty property,
String newValue)
Overrides the given property value with the new value for the given resource. |
void |
setPersistentProperty(String key,
String value)
Sets a persistent property of this resource. |
void |
setSessionProperty(QualifiedName key,
Object value)
Sets the value of a session property of this resource. |
| Methods inherited from interface org.eclipse.core.runtime.IAdaptable |
|---|
getAdapter |
| Field Detail |
|---|
static final String COPY_RIGHT
| Method Detail |
|---|
String getName()
IPhysicalResource getPhysicalResource()
IPhysicalResource representing the physical resource,
or null if the ILogicalResource does not represent
a physical resource.IPath getFullPath()
PROJECT_NAME/SUBPROJECT_NAME/DATA_SET_NAME/MEMBER_NAME.
Depending on the type of this ILogicalResource, some of
the path segments may be left out.
IPath containing the full path of this resource.
void delete(boolean force,
IProgressMonitor monitor)
throws OperationFailedException
force - Currently not used. It is recommended to set this to
true for now.monitor - a progress monitor, or null if progress
reporting is not desired
OperationFailedException
void rename(String newName)
throws OperationFailedException
newName - a String containing the new name for the resource
OperationFailedExceptionvoid remove()
void refresh(int depth,
IProgressMonitor monitor)
depth - is modeled after the concept for IResource:
IResource.DEPTH_ZERO: indicates this resource,
but not any of its members, is refreshed. IResource.DEPTH_ONE: indicates this resource and
its direct members are refreshed. IResource.DEPTH_INFINITE: indicates this
resource and its direct and indirect members at any depth are
refreshed. monitor - a progress monitor, or null if progress
reporting is not desiredILogicalResource.setStalenessLevel(int)ILogicalContainer getLogicalParent()
ILogicalContainer which is the parent of this
resourceILogicalSubProject getSubProject()
IResourcePublisher getResourcePublisher()
This method should not return null. Implementers of
ILogicalResource must create a new
IResourcePublisher instance if one has not yet been created.
null.
void setPersistentProperty(String key,
String value)
IPhysicalResourceCoreConstants.
Persistent properties are saved and restored across workbench shutdown and restart.
key - a String containing the key of the property to be setvalue - a String containing the value to be assigned to the property,
or null to remove the propertyString getPersistentProperty(String key)
IPhysicalResourceCoreConstants.
Persistent properties are saved and restored across workbench shutdown and restart.
key - a String containing the key of the property whose value is
requested
null if this resource has no such property.
void setSessionProperty(QualifiedName key,
Object value)
null then the property is removed.
Session properties will be cleared after workbench shutdown.
key - a QualifiedName which contains the key of the property
whose value is to be setvalue - an Object which is to be saved for the specified keyObject getSessionProperty(QualifiedName key)
null if this resource has no such property
Session properties will be cleared after workbench shutdown.
key - a QualifiedName which contains the key of the property
whose value is requested
Object containing the value of the property, or
null if this resource has no such property.void setCurrentPropertyGroup(IPropertyGroup propertyGroup)
propertyGroup - The property group that will be the current property group,
or null to remove the current property group.ILogicalResource.getCurrentPropertyGroup()IPropertyGroup getCurrentPropertyGroup()
void setOverride(IProperty property,
String newValue)
throws UnsupportedOperationException,
IllegalPropertyException
property - The property to be overridden.newValue - The new value.
UnsupportedOperationException - If the resource does not support property
overrides.
IllegalPropertyException - If the current property group for this resource does
not have a category instance with the given property, or if the current property group is
null.
void deleteOverride(IProperty property)
throws UnsupportedOperationException,
NoOverrideException
property - The property that was overridden.
UnsupportedOperationException - If the resource does not support property
overrides.
NoOverrideException - If there is no override for the given property for this
resource.
List getOverriddenProperties()
throws UnsupportedOperationException
UnsupportedOperationException - If the resource does not support property
overrides.
void deleteOverriddenPropertiesInCategory(ICategory category)
throws UnsupportedOperationException,
NoOverrideException
category - The overridden properties of the category instance for this
category are deleted.
UnsupportedOperationException - If this resource does not support overrides for
properties.
NoOverrideException
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||