|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface ResourceContainer
A representation of the model object 'Resource Container'. A container object in the CARMA system
The following features are supported:
ModelPackage.getResourceContainer()| Field Summary | |
|---|---|
static java.lang.String |
copyright
|
static int |
INFINITE_DEPTH
Constant representing an infinite depth find. |
| Fields inherited from interface com.ibm.carma.model.CARMAResource |
|---|
NO_EXTENSION |
| Fields inherited from interface com.ibm.carma.model.Filterable |
|---|
WILDCARD |
| Method Summary | |
|---|---|
CARMAContainer |
createContainer(org.eclipse.core.runtime.IProgressMonitor pm,
java.lang.String newContainerName,
java.lang.Object[] parameters)
Send the "createContainer" command to the RAM on the host. |
CARMAMember |
createMember(org.eclipse.core.runtime.IProgressMonitor pm,
java.lang.String newMemberName,
java.lang.Object[] parameters)
Send the "createMember" command to the RAM on the host. |
CARMAMember |
createMemberWithContents(org.eclipse.core.runtime.IProgressMonitor pm,
java.lang.String newMemberName,
java.io.InputStream fileStream,
java.lang.String encoding,
java.lang.Boolean isBinary,
java.lang.Object[] parameters)
Send the "createMember" command to the RAM on the host and initialize the contents to the given filestream. |
CARMAContent |
findResource(java.lang.String memberId,
int depth)
Find an instance of CARMA content referenced by the given member ID |
org.eclipse.emf.common.util.EList |
getContainerContents()
Returns the value of the 'Container Contents' containment reference list. |
boolean |
isSetContainerContents()
Returns whether the value of the ' Container Contents' containment reference list is set. |
| Methods inherited from interface com.ibm.carma.model.CARMAResource |
|---|
delete, delete, getCARMA, getFileName, getLastRefreshTime, getLocalExtension, getMemberId, getMemberInfo, getMemberInfoMap, getName, getRamExtension, getRepository, getRepositoryManager, isBinary, isSetBinary, isSetLocalExtension, isSetMemberInfoMap, isSetRamExtension, refreshMemberInfo, refreshRAMFileExtension, setBinary, setLocalExtension, setMemberInfo, setName, unsetBinary, unsetLocalExtension |
| 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 |
| Methods inherited from interface com.ibm.carma.model.Filterable |
|---|
getFilters, isFilterReady, refresh, refresh, refreshWithAllMemberInfo, refreshWithMemberInfo, removeFilter, resolveFilter |
| 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 int INFINITE_DEPTH
| Method Detail |
|---|
org.eclipse.emf.common.util.EList getContainerContents()
throws NotSynchronizedException
CARMAContent.
It is bidirectional and its opposite is 'Container'.
Returns the CARMA Resource contents of the container
NotSynchronizedExceptionisSetContainerContents(),
ModelPackage.getResourceContainer_ContainerContents(),
CARMAContent.getContainer()boolean isSetContainerContents()
Container Contents' containment reference list is set.
Returns true if the Container Contents list has been initialized
getContainerContents()
CARMAMember createMember(org.eclipse.core.runtime.IProgressMonitor pm,
java.lang.String newMemberName,
java.lang.Object[] parameters)
throws org.eclipse.core.runtime.CoreException,
UnsupportedCARMAOperationException,
NotConnectedException
PUT).
This method is mainly to inform the RAM that the client intends on working with the member created
and to prepare appropriately.
The createMember 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 operationnewMemberName - the name of the new container that should be createdparameters - 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 or Repository Manager is not active.
UnsupportedCARMAOperationException - The action could not be performed because the action is not supported by the Repository Manager on the hostActionIdentifier.CREATE_MEMBER
CARMAMember createMemberWithContents(org.eclipse.core.runtime.IProgressMonitor pm,
java.lang.String newMemberName,
java.io.InputStream fileStream,
java.lang.String encoding,
java.lang.Boolean isBinary,
java.lang.Object[] parameters)
throws org.eclipse.core.runtime.CoreException,
NotConnectedException,
UnsupportedCARMAOperationException
createMemberWithContents 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 operationnewMemberName - the name of the new container that should be createdfileStream - the file contents that should be set as the initial contents of the new memberencoding - the encoding of the member on the hostisBinary - the transfer type of the member. If true, the member will be sent to the host as binary and the encoding ignored.parameters - 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 or Repository Manager is not active.
UnsupportedCARMAOperationException - The action could not be performed because the action is not supported by the Repository Manager on the hostActionIdentifier.CREATE_MEMBER_WITH_CONTENTS
CARMAContainer createContainer(org.eclipse.core.runtime.IProgressMonitor pm,
java.lang.String newContainerName,
java.lang.Object[] parameters)
throws org.eclipse.core.runtime.CoreException,
UnsupportedCARMAOperationException,
NotConnectedException
createContainer 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 operationnewContainerName - the name of the new container that should be createdparameters - 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 or Repository Manager is not active.
UnsupportedCARMAOperationException - The action could not be performed because the action is not supported by the Repository Manager on the hostActionIdentifier.CREATE_CONTAINER
CARMAContent findResource(java.lang.String memberId,
int depth)
throws NotSynchronizedException,
org.eclipse.core.runtime.CoreException
memberId - the member Id of the resource to locate in the children listdepth - the number of levels of children to search
NotSynchronizedException - The search encountered an area of the CARMA hierarchy which is not initialized. The hierarchy needs to be
refreshed before the method can search the entire known hierarchy for the member Id.
org.eclipse.core.runtime.CoreException - An error occured during execution of the command
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||