|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface IPhysicalResource
The IPhysicalResource provides a generic interface for a
resource in the physical model layer. The physical model layer represents
the physical resource tree in a remote file system such as the z/OS file
system.
The IPhysicalResource has two generic subinterfaces -
IPhysicalFile and IPhysicalContainer. The
IPhysicalFile represents a physical resource that holds data,
and the IPhysicalContainer contains other physical resources.
Each file system provides more interfaces that extend the
IPhysicalResource. For example,
ZOSResource for
the z/OS file system, etc.
| 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. |
boolean |
exists()
Determines whether this resource actually exists in the system. |
IPropertyGroup |
getCurrentPropertyGroup()
Returns the current property group for the resource. |
IPath |
getFullPath()
Returns the full path of this resource, relative to the containing IResourceRoot. |
long |
getModificationStamp()
Returns the time when the resource was last modified. |
long |
getModificationStamp(boolean force)
Returns the time when the resource was last modified. |
String |
getName()
Returns the name of this resource. |
List |
getOverriddenProperties()
Returns the overridden properties for this resource. |
IContainer |
getParent()
Gets the resource which is the parent of this resource. |
String |
getPersistentProperty(String key)
Returns the value of the persistent property of this resource identified by the given key. |
IResourcePublisher |
getResourcePublisher()
Returns the resource publisher that manages subscriptions for this specific resource. |
Object |
getSessionProperty(QualifiedName key)
Returns the value of the session property of this resource identified by the given key. |
void |
refresh(int depth,
IProgressMonitor monitor)
Refreshes the resource hierarchy from this resource and its children to the specified depth. |
void |
rename(String name)
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 the value of the persistent property of this resource identified by the given key. |
void |
setSessionProperty(QualifiedName key,
Object value)
Sets the value of the session property of this resource identified by the given key. |
| Methods inherited from interface org.eclipse.core.runtime.IAdaptable |
|---|
getAdapter |
| Field Detail |
|---|
static final String COPY_RIGHT
| Method Detail |
|---|
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 - if the delete operation failsboolean exists()
true if the resource exists; false
otherwiseIPath getFullPath()
IResourceRoot.
long getModificationStamp()
long getModificationStamp(boolean force)
force - true if you want a fresh time stamp from the remote system,
false if you want a cached value
IContainer getParent()
null
if it has no parent (that is, this resource is the root of the
resource model).
void refresh(int depth,
IProgressMonitor monitor)
depth - one of the following values:
monitor - a progress monitor, or null if progress
reporting is not desiredIPhysicalResource.isRefreshing()String getName()
void rename(String name)
throws OperationFailedException
name - the new name for this resource
OperationFailedException - if the rename operation failsIResourcePublisher getResourcePublisher()
This method should not return null. Implementer
should create a new instance if it was not created yet.
null.String getPersistentProperty(String key)
If the resource's property value is null, then tries to
get a value from its container. The search is continued up the tree
until a non-null value is returned or reached to the top of the tree.
Note that an empty string is treated as a valid value so that a resource
can override its parent property with a blank.
The persistent properties will persist across workbench shut down and restart.
key - the name of the property to be retrieved
null if no value is foundIPhysicalResource.setPersistentProperty(String, String)
void setPersistentProperty(String key,
String value)
null, then
the persistent property is removed from the resource.
The persistent properties will persist across workbench shut down and restart.
key - the name of the propertyvalue - the value of the property, or null if the
property is to be removedIPhysicalResource.getPersistentProperty(String)Object getSessionProperty(QualifiedName key)
If the resource's property value is null, then tries to
get a value from its container. The search is continued up the tree
until a non-null value is returned or reached to the top of the tree.
Note that an empty string is treated as a valid value so that a resource
can override its parent property with a blank.
The session properties will not be retained after the workbench has been shut down.
key - the qualified name of the property to be retrieved
null if no value is foundIPhysicalResource.setSessionProperty(QualifiedName, Object)
void setSessionProperty(QualifiedName key,
Object value)
null, then
the persistent property is removed from the resource.
The session properties will not be retained after the workbench has been shut down.
key - the qualified name of the propertyvalue - the value of the property, or null if the
property is to be removedIPhysicalResource.getSessionProperty(QualifiedName)void setCurrentPropertyGroup(IPropertyGroup propertyGroup)
propertyGroup - The property group that will be the current property group,
or null to remove the current property group.IPhysicalResource.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 | |||||||||