com.ibm.carma.model
Interface ResourceContainer

All Superinterfaces:
CARMAResource, CustomActionAccepter, org.eclipse.emf.ecore.EObject, Filterable, org.eclipse.core.runtime.IAdaptable, org.eclipse.emf.common.notify.Notifier
All Known Subinterfaces:
CARMAContainer, RepositoryInstance

public interface ResourceContainer
extends CARMAResource, Filterable

A representation of the model object 'Resource Container'. A container object in the CARMA system

The following features are supported:

See Also:
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

copyright

static final java.lang.String copyright

See Also:
Constant Field Values

INFINITE_DEPTH

static final int INFINITE_DEPTH
Constant representing an infinite depth find.

Since:
7.1
See Also:
Constant Field Values
Method Detail

getContainerContents

org.eclipse.emf.common.util.EList getContainerContents()
                                                       throws NotSynchronizedException
Returns the value of the 'Container Contents' containment reference list. The list contents are of type CARMAContent. It is bidirectional and its opposite is 'Container'. Returns the CARMA Resource contents of the container

Returns:
the value of the 'Container Contents' containment reference list.
Throws:
NotSynchronizedException
See Also:
isSetContainerContents(), ModelPackage.getResourceContainer_ContainerContents(), CARMAContent.getContainer()

isSetContainerContents

boolean isSetContainerContents()
Returns whether the value of the 'Container Contents' containment reference list is set. Returns true if the Container Contents list has been initialized

Returns:
whether the value of the 'Container Contents' containment reference list is set.
See Also:
getContainerContents()

createMember

CARMAMember createMember(org.eclipse.core.runtime.IProgressMonitor pm,
                         java.lang.String newMemberName,
                         java.lang.Object[] parameters)
                         throws org.eclipse.core.runtime.CoreException,
                                UnsupportedCARMAOperationException,
                                NotConnectedException
Send the "createMember" command to the RAM on the host. The RAM is not required to create any physical representation of the member on the host until other actions are performed against it (e.g., 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:

Create a new CARMA member as a child of the current container.

Parameters:
pm - progress monitor for the operation
newMemberName - the name of the new container that should be created
parameters - the set of parameters required for the method to execute properly
Throws:
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 host
See Also:
ActionIdentifier.CREATE_MEMBER

createMemberWithContents

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
Send the "createMember" command to the RAM on the host and initialize the contents to the given filestream. The 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:

Create a CARMA member as a child of the current container with the given file contents. The remote encoding of the file will be set to the default codepage of the connection.

Parameters:
pm - progress monitor for the operation
newMemberName - the name of the new container that should be created
fileStream - the file contents that should be set as the initial contents of the new member
encoding - the encoding of the member on the host
isBinary - 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
Throws:
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 host
Since:
7.0
See Also:
ActionIdentifier.CREATE_MEMBER_WITH_CONTENTS

createContainer

CARMAContainer createContainer(org.eclipse.core.runtime.IProgressMonitor pm,
                               java.lang.String newContainerName,
                               java.lang.Object[] parameters)
                               throws org.eclipse.core.runtime.CoreException,
                                      UnsupportedCARMAOperationException,
                                      NotConnectedException
Send the "createContainer" command to the RAM on the host. The RAM is not required to create any physical representation of the container on the host until other actions are performed against it. This method is mainly to inform the RAM that the client intends on working with the container created and to prepare appropriately. The 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:

Create a new CARMA container as a child of the current container.

Parameters:
pm - progress monitor for the operation
newContainerName - the name of the new container that should be created
parameters - the set of parameters required for the method to execute properly
Throws:
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 host
See Also:
ActionIdentifier.CREATE_CONTAINER

findResource

CARMAContent findResource(java.lang.String memberId,
                          int depth)
                          throws NotSynchronizedException,
                                 org.eclipse.core.runtime.CoreException
Find an instance of CARMA content referenced by the given member ID

Parameters:
memberId - the member Id of the resource to locate in the children list
depth - the number of levels of children to search
Throws:
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