|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface CARMAResource
A representation of the model object 'CARMA Resource'. A resource of the CARMA system representing content created by a Repository manager object
The following features are supported:
Member IdNameFile NameLast Refresh TimeLocal ExtensionRam ExtensionBinaryRepositoryMember Info Map
ModelPackage.getCARMAResource()| Field Summary | |
|---|---|
static java.lang.String |
copyright
|
static java.lang.String |
NO_EXTENSION
Contstant value for time when the user sets that no extension should be applied to the given resource |
| Method Summary | |
|---|---|
CARMAReturn |
delete(org.eclipse.core.runtime.IProgressMonitor pm,
boolean force,
java.lang.Object[] parameters)
Removes the CARMA Resource from the CARMA content hierarchy |
CARMAReturn |
delete(org.eclipse.core.runtime.IProgressMonitor pm,
java.lang.Object[] parameters)
Removes the CARMA Resource from the CARMA content hierarchy with the force option set to false |
CARMA |
getCARMA()
Returns the CARMA connection manager associated with the CARMA resource |
java.lang.String |
getFileName()
Returns the value of the 'File Name' attribute. |
java.util.Date |
getLastRefreshTime()
Returns the value of the 'Last Refresh Time' attribute. |
java.lang.String |
getLocalExtension()
Returns the value of the 'Local Extension' attribute. |
java.lang.String |
getMemberId()
Returns the value of the 'Member Id' attribute. |
java.lang.String |
getMemberInfo(org.eclipse.core.runtime.IProgressMonitor pm,
java.lang.String key,
java.lang.Object[] parameters)
Retrieves a specific piece of member information (meta-data) from the host relating to the CARMA resource. |
org.eclipse.emf.common.util.EMap |
getMemberInfoMap()
Returns the value of the 'Member Info Map' map. |
java.lang.String |
getName()
Returns the value of the 'Name' attribute. |
java.lang.String |
getRamExtension()
Returns the value of the 'Ram Extension' attribute. |
RepositoryInstance |
getRepository()
Returns the value of the 'Repository' reference. |
RepositoryManager |
getRepositoryManager()
Returns the repository manager associated with the CARMA resource |
boolean |
isBinary()
Returns the value of the 'Binary' attribute. |
boolean |
isSetBinary()
Returns whether the value of the ' Binary' attribute is set. |
boolean |
isSetLocalExtension()
Returns whether the value of the ' Local Extension' attribute is set. |
boolean |
isSetMemberInfoMap()
Returns whether the value of the ' Member Info Map' map is set. |
boolean |
isSetRamExtension()
Returns whether the value of the ' Ram Extension' attribute is set. |
void |
refreshMemberInfo(org.eclipse.core.runtime.IProgressMonitor pm,
boolean sendNotification,
java.lang.Object[] parameters)
Updates the list of member information (meta-data) for all information relating to the CARMA resource on the host. |
void |
refreshRAMFileExtension(org.eclipse.core.runtime.IProgressMonitor pm,
java.lang.Object[] parameters)
Updates the file extension member information (meta-data) for the CARMA resource by querying the RAM for the file extension key on the host. |
void |
setBinary(boolean value)
Sets the value of the ' Binary' attribute. |
void |
setLocalExtension(java.lang.String value)
Sets the value of the ' Local Extension' attribute. |
void |
setMemberInfo(org.eclipse.core.runtime.IProgressMonitor pm,
java.lang.String key,
java.lang.String value,
java.lang.Object[] parameters)
Sets the value of a specific piece of member information (meta-data) for the CARMA resource on the host The setMemberInfo action specification can be located using the
CustomActionAccepter.findActionFor(String) method and inspecting the action
object returned. |
void |
setName(java.lang.String value)
Sets the value of the ' Name' attribute. |
void |
unsetBinary()
Unsets the value of the ' Binary' attribute. |
void |
unsetLocalExtension()
Unsets the value of the ' Local Extension' attribute. |
| Methods inherited from interface com.ibm.carma.model.CustomActionAccepter |
|---|
findActionFor, markActionUnsupported, performAction |
| Methods inherited from interface org.eclipse.emf.ecore.EObject |
|---|
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset |
| Methods inherited from interface org.eclipse.emf.common.notify.Notifier |
|---|
eAdapters, eDeliver, eNotify, eSetDeliver |
| Methods inherited from interface org.eclipse.core.runtime.IAdaptable |
|---|
getAdapter |
| Field Detail |
|---|
static final java.lang.String copyright
static final java.lang.String NO_EXTENSION
| Method Detail |
|---|
java.lang.String getMemberId()
ModelPackage.getCARMAResource_MemberId()java.lang.String getName()
The name of the resource to display to user's navigating the CARMA content hierachy
Displayable name of the object
setName(String),
ModelPackage.getCARMAResource_Name()void setName(java.lang.String value)
Name' attribute.
value - the new value of the 'Name' attribute.getName()java.lang.String getFileName()
ModelPackage.getCARMAResource_FileName()java.util.Date getLastRefreshTime()
ModelPackage.getCARMAResource_LastRefreshTime()java.lang.String getLocalExtension()
"" .
The local extension to provide for the resource/children
of the resource when viewing the resource contents
isSetLocalExtension(),
unsetLocalExtension(),
setLocalExtension(String),
ModelPackage.getCARMAResource_LocalExtension()void setLocalExtension(java.lang.String value)
Local Extension' attribute.
value - the new value of the 'Local Extension' attribute.isSetLocalExtension(),
unsetLocalExtension(),
getLocalExtension()void unsetLocalExtension()
Local Extension' attribute.
When the local extension is unset, the extension is inherited from the parent object
isSetLocalExtension(),
getLocalExtension(),
setLocalExtension(String)boolean isSetLocalExtension()
Local Extension' attribute is set.
When the value returned is "false", the extension is inherited from the parent object
unsetLocalExtension(),
getLocalExtension(),
setLocalExtension(String)java.lang.String getRamExtension()
isSetRamExtension(),
ModelPackage.getCARMAResource_RamExtension()boolean isSetRamExtension()
Ram Extension' attribute is set.
getRamExtension()boolean isBinary()
"false".
Marks the CARMA member as a binary member. A binary member signals to the host that the contents of the member should not have codepage conversion or record delimiting performed
isSetBinary(),
unsetBinary(),
setBinary(boolean),
ModelPackage.getCARMAResource_Binary()void setBinary(boolean value)
Binary' attribute.
value - the new value of the 'Binary' attribute.isSetBinary(),
unsetBinary(),
isBinary()void unsetBinary()
Binary' attribute.
When the binary flag is unset, the binary attribute is inherited from the parent object
isSetBinary(),
isBinary(),
setBinary(boolean)boolean isSetBinary()
Binary' attribute is set.
When this method returns "false", the binary attribute is inherited from the parent object
unsetBinary(),
isBinary(),
setBinary(boolean)
RepositoryInstance getRepository()
throws java.lang.IllegalStateException
java.lang.IllegalStateExceptionModelPackage.getCARMAResource_Repository(),
RepositoryInstance
RepositoryManager getRepositoryManager()
throws java.lang.IllegalStateException
java.lang.IllegalStateException - repository manager is not set
CARMA getCARMA()
throws java.lang.IllegalStateException
java.lang.IllegalStateException - CARMA connection manager is not set
org.eclipse.emf.common.util.EMap getMemberInfoMap()
throws NotSynchronizedException
String,
and the value is of type Object,
Map of member information (meta-data) relating to the resource
NotSynchronizedException - Exception is thrown when the Member Info Map has not been initialized and
requires a refreshMemberInfo(IProgressMonitor, boolean, Object[]) operation in order to initialize the attributeisSetMemberInfoMap(),
ModelPackage.getCARMAResource_MemberInfoMap()boolean isSetMemberInfoMap()
Member Info Map' map is set.
Returns true if the Member Info Map has been initialized
getMemberInfoMap()
CARMAReturn delete(org.eclipse.core.runtime.IProgressMonitor pm,
java.lang.Object[] parameters)
throws org.eclipse.core.runtime.CoreException,
UnsupportedCARMAOperationException,
NotConnectedException
The delete action specification can be located using the
CustomActionAccepter.findActionFor(String) method and inspecting the action
object returned. The parameter array is expected to consist of object values of
the type defined by the action parameter list in the order
specified by the parameter list.
The parameters array should:
parameters specificationtype specified for each parameter
pm - progress monitor for the operationparameters - the set of parameters required for the method to execute properly
org.eclipse.core.runtime.CoreException - An error occured during execution of the command
NotConnectedException - The action could not be performed because the CARMA connection is not active.
UnsupportedCARMAOperationException - The action could not be performed because the action is not supported by the Repository Manager on the hostdelete(IProgressMonitor, boolean, Object[]),
ActionIdentifier.DELETE
CARMAReturn delete(org.eclipse.core.runtime.IProgressMonitor pm,
boolean force,
java.lang.Object[] parameters)
throws org.eclipse.core.runtime.CoreException,
UnsupportedCARMAOperationException,
NotConnectedException
The delete action specification can be located using the
CustomActionAccepter.findActionFor(String) method and inspecting the action
object returned. The parameter array is expected to consist of object values of
the type defined by the action parameter list in the order
specified by the parameter list.
The parameters array should:
parameters specificationtype specified for each parameter
pm - progress monitor for the operationforce - set to true if the delete should be forced on the RAMparameters - the set of parameters required for the method to execute properly
org.eclipse.core.runtime.CoreException - An error occured during execution of the command
NotConnectedException - The action could not be performed because the CARMA connection is not active.
UnsupportedCARMAOperationException - The action could not be performed because the action is not supported by the Repository Manager on the hostActionIdentifier.DELETE
java.lang.String getMemberInfo(org.eclipse.core.runtime.IProgressMonitor pm,
java.lang.String key,
java.lang.Object[] parameters)
throws org.eclipse.core.runtime.CoreException,
UnsupportedCARMAOperationException,
NotConnectedException
The getMemberInfo action specification can be located using the
CustomActionAccepter.findActionFor(String) method and inspecting the action
object returned. The parameter array is expected to consist of object values of
the type defined by the action parameter list in the order
specified by the parameter list.
The parameters array should:
parameters specificationtype specified for each parameter
pm - progress monitor for the operationkey - the key of the member information key-value pair to inspectparameters - the set of parameters required for the method to execute properly
org.eclipse.core.runtime.CoreException - An error occured during execution of the command
NotConnectedException - The action could not be performed because the CARMA connection is not active.
UnsupportedCARMAOperationException - The action could not be performed because the action is not supported by the Repository Manager on the hostActionIdentifier.GET_MEMBER_INFO
void setMemberInfo(org.eclipse.core.runtime.IProgressMonitor pm,
java.lang.String key,
java.lang.String value,
java.lang.Object[] parameters)
throws org.eclipse.core.runtime.CoreException,
UnsupportedCARMAOperationException,
NotConnectedException
setMemberInfo action specification can be located using the
CustomActionAccepter.findActionFor(String) method and inspecting the action
object returned. The parameter array is expected to consist of object values of
the type defined by the action parameter list in the order
specified by the parameter list.
The parameters array should:
parameters specificationtype specified for each parameter
pm - progress monitor for the operationkey - the key of the member information key-value pair to set to the given valuevalue - the value to set the associated key lookup toparameters - the set of parameters required for the method to execute properly
org.eclipse.core.runtime.CoreException - An error occured during execution of the command
NotConnectedException - The action could not be performed because the CARMA connection is not active.
UnsupportedCARMAOperationException - The action could not be performed because the action is not supported by the Repository Manager on the hostActionIdentifier.GET_MEMBER_INFO
void refreshMemberInfo(org.eclipse.core.runtime.IProgressMonitor pm,
boolean sendNotification,
java.lang.Object[] parameters)
throws org.eclipse.core.runtime.CoreException,
UnsupportedCARMAOperationException,
NotConnectedException
refreshMemberInfo action specification can be located using the
CustomActionAccepter.findActionFor(String) method and inspecting the action
object returned. The parameter array is expected to consist of object values of
the type defined by the action parameter list in the order
specified by the parameter list.
The parameters array should:
parameters specificationtype specified for each parameter
pm - progress monitor for the operationsendNotification - set to true if notification messages should be issued from changes made during the refresh operationparameters - the set of parameters required for the method to execute properly
org.eclipse.core.runtime.CoreException - An error occured during execution of the command
NotConnectedException - The action could not be performed because the CARMA connection is not active.
UnsupportedCARMAOperationException - The action could not be performed because the action is not supported by the Repository Manager on the hostActionIdentifier.REFRESH_ALL_MEMBER_INFO
void refreshRAMFileExtension(org.eclipse.core.runtime.IProgressMonitor pm,
java.lang.Object[] parameters)
throws org.eclipse.core.runtime.CoreException,
NotConnectedException,
UnsupportedCARMAOperationException
file extension key on the host.
The refreshMemberInfo action specification can be located using the
CustomActionAccepter.findActionFor(String) method and inspecting the action
object returned. The parameter array is expected to consist of object values of
the type defined by the action parameter list in the order
specified by the parameter list.
The parameters array should:
parameters specificationtype specified for each parameter
pm - progress monitor for the operationparameters - the set of parameters required for the method to execute properly
org.eclipse.core.runtime.CoreException - An error occured during execution of the command
NotConnectedException - The action could not be performed because the CARMA connection is not active.
UnsupportedCARMAOperationException - The action could not be performed because the action is not supported by the Repository Manager on the hostActionIdentifier.REFRESH_ALL_MEMBER_INFO,
refreshMemberInfo(IProgressMonitor, boolean, Object[])
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||