com.ibm.carma.model
Interface CARMAMember

All Superinterfaces:
CARMAContent, CARMAResource, Convertable, CustomActionAccepter, org.eclipse.emf.ecore.EObject, org.eclipse.core.runtime.IAdaptable, Managed, Movable, org.eclipse.emf.common.notify.Notifier
All Known Subinterfaces:
CARMAMemberVersion

public interface CARMAMember
extends CARMAContent, CARMAResource, Convertable, Movable, Managed

A representation of the model object 'CARMA Member'. A CARMA resource associated with file contents

The following features are supported:

See Also:
ModelPackage.getCARMAMember()

Field Summary
static java.lang.String copyright
           
 
Fields inherited from interface com.ibm.carma.model.CARMAResource
NO_EXTENSION
 
Method Summary
 CARMAReturn copyFromExternal(org.eclipse.core.runtime.IProgressMonitor pm, java.lang.String remoteLocation, java.lang.Object[] parameters)
           
 CARMAReturn copyToExternal(org.eclipse.core.runtime.IProgressMonitor pm, java.lang.String remoteLocation, java.lang.Object[] parameters)
           
 int getLRECL()
          Returns the value of the 'LRECL' attribute.
 FileReturn getMemberContents(org.eclipse.core.runtime.IProgressMonitor pm, java.lang.Object[] parameters)
           
 java.lang.String getRecFM()
          Returns the value of the 'Rec FM' attribute.
 java.lang.String getVersion()
          Returns the value of the 'Version' attribute.
 org.eclipse.emf.common.util.EList getVersionHistory()
          Returns the value of the 'Version History' containment reference list.
 boolean isSetLRECL()
          Returns whether the value of the 'LRECL' attribute is set.
 boolean isSetRecFM()
          Returns whether the value of the 'Rec FM' attribute is set.
 boolean isSetVersion()
          Returns whether the value of the 'Version' attribute is set.
 boolean isSetVersionHistory()
          Returns whether the value of the 'Version History' containment reference list is set.
 CARMAReturn refreshVersionHistory(org.eclipse.core.runtime.IProgressMonitor pm, boolean sendNotification, java.lang.Object[] parameters)
           
 CARMAReturn refreshVersionHistoryWithMemberInfo(org.eclipse.core.runtime.IProgressMonitor pm, boolean sendNotification, java.lang.String[] keys, java.lang.Object[] parameters)
           
 CARMAReturn setMemberContents(org.eclipse.core.runtime.IProgressMonitor pm, java.lang.Object[] parameters, java.io.InputStream fileStream)
           
 
Methods inherited from interface com.ibm.carma.model.CARMAContent
getContainer
 
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.Managed
checkin, checkout, lock, unlock
 
Methods inherited from interface com.ibm.carma.model.Movable
copy, move
 
Methods inherited from interface com.ibm.carma.model.Convertable
getBidiOptions, getBidiOptionsFile, getLocalCodepage, getRemoteCodepage, isSetBidiOptions, isSetBidiOptionsFile, isSetLocalCodepage, isSetRemoteCodepage, setBidiOptions, setBidiOptionsFile, setLocalCodepage, setRemoteCodepage, unsetBidiOptions, unsetBidiOptionsFile, unsetLocalCodepage, unsetRemoteCodepage
 

Field Detail

copyright

static final java.lang.String copyright

See Also:
Constant Field Values
Method Detail

getLRECL

int getLRECL()
Returns the value of the 'LRECL' attribute. Record length of the CARMA member

Returns:
the value of the 'LRECL' attribute.
See Also:
isSetLRECL(), ModelPackage.getCARMAMember_LRECL()

isSetLRECL

boolean isSetLRECL()
Returns whether the value of the 'LRECL' attribute is set.

Returns:
whether the value of the 'LRECL' attribute is set.
See Also:
getLRECL()

getRecFM

java.lang.String getRecFM()
Returns the value of the 'Rec FM' attribute. record format of the CARMA member content

Returns:
the value of the 'Rec FM' attribute.
See Also:
isSetRecFM(), ModelPackage.getCARMAMember_RecFM()

isSetRecFM

boolean isSetRecFM()
Returns whether the value of the 'Rec FM' attribute is set.

Returns:
whether the value of the 'Rec FM' attribute is set.
See Also:
getRecFM()

getVersion

java.lang.String getVersion()
Returns the value of the 'Version' attribute. The version identifier of the resource

Returns:
the value of the 'Version' attribute.
See Also:
isSetVersion(), ModelPackage.getCARMAMember_Version()

isSetVersion

boolean isSetVersion()
Returns whether the value of the 'Version' attribute is set.

Returns:
whether the value of the 'Version' attribute is set.
See Also:
getVersion()

getVersionHistory

org.eclipse.emf.common.util.EList getVersionHistory()
                                                    throws NotSynchronizedException
Returns the value of the 'Version History' containment reference list. The list contents are of type CARMAMemberVersion. The list of prior versions for the CARMA member

Returns:
the value of the 'Version History' containment reference list.
Throws:
NotSynchronizedException
See Also:
isSetVersionHistory(), ModelPackage.getCARMAMember_VersionHistory()

isSetVersionHistory

boolean isSetVersionHistory()
Returns whether the value of the 'Version History' containment reference list is set.

Returns:
whether the value of the 'Version History' containment reference list is set.
See Also:
getVersionHistory()

getMemberContents

FileReturn getMemberContents(org.eclipse.core.runtime.IProgressMonitor pm,
                             java.lang.Object[] parameters)
                             throws org.eclipse.core.runtime.CoreException,
                                    UnsupportedCARMAOperationException,
                                    NotConnectedException

The getMemberContents 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:

Returns byte contents for the file associated with the member

Parameters:
pm - Progress meter for the operation
parameters - Custom Parameters required by the Repository manager in the parameter order specified by the action description
Returns:
a filestream of member (byte) contents. The return includes the custom return response from the method execution
Throws:
org.eclipse.core.runtime.CoreException - An error occurred 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 host

setMemberContents

CARMAReturn setMemberContents(org.eclipse.core.runtime.IProgressMonitor pm,
                              java.lang.Object[] parameters,
                              java.io.InputStream fileStream)
                              throws org.eclipse.core.runtime.CoreException,
                                     UnsupportedCARMAOperationException,
                                     NotConnectedException

The setMemberContents 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:

Sets the byte contents for the file associated with the member

Parameters:
pm - Progress monitor for the operation
parameters - Custom Parameters required by the Repository manager in the parameter order specified by the action description
fileStream - The byte stream of the contents of the associated CARMA member file
Returns:
the custom return response from the method execution
Throws:
org.eclipse.core.runtime.CoreException - An error occurred 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 host

copyToExternal

CARMAReturn copyToExternal(org.eclipse.core.runtime.IProgressMonitor pm,
                           java.lang.String remoteLocation,
                           java.lang.Object[] parameters)
                           throws org.eclipse.core.runtime.CoreException,
                                  UnsupportedCARMAOperationException,
                                  NotConnectedException

The copyToExternal 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:

Copies the CARMA member to a remote host location

Parameters:
pm - Progress monitor for the operation
remoteLocation - The remote location the CARMA member should be copied to, either a Sequential Data Set [xxx.xxx.xxx] or a PDS member [xxxx.xxxx.xxx(meber)]
parameters - Custom Parameters required by the Repository manager in the parameter order specified by the action description
Returns:
the custom return response from the method execution
Throws:
org.eclipse.core.runtime.CoreException - An error occurred 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 host

copyFromExternal

CARMAReturn copyFromExternal(org.eclipse.core.runtime.IProgressMonitor pm,
                             java.lang.String remoteLocation,
                             java.lang.Object[] parameters)
                             throws org.eclipse.core.runtime.CoreException,
                                    UnsupportedCARMAOperationException,
                                    NotConnectedException

The copyFromExternal 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:
pm - Progress monitor for the operation
remoteLocation - The remote location member that should be copied into the CARMA member contents, either a Sequential Data Set [xxx.xxx.xxx] or a PDS member [xxxx.xxxx.xxx(meber)]
parameters - Custom Parameters required by the Repository manager in the parameter order specified by the action description
Returns:
the custom return response from the method execution
Throws:
org.eclipse.core.runtime.CoreException - An error occurred 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 host

refreshVersionHistory

CARMAReturn refreshVersionHistory(org.eclipse.core.runtime.IProgressMonitor pm,
                                  boolean sendNotification,
                                  java.lang.Object[] parameters)
                                  throws org.eclipse.core.runtime.CoreException,
                                         UnsupportedCARMAOperationException,
                                         NotConnectedException

The refreshVersionHistory 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:

Refresh the cache of version history for the resource.

Parameters:
pm - progress monitor for the operation
sendNotification - flag indicates if notification should be sent to listeners when changes occur to the version list during update
parameters - Custom parameters as required by the Repository Manager
Returns:
the custom return response from the method execution
Throws:
org.eclipse.core.runtime.CoreException - An error occurred 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 host
Since:
7.1

refreshVersionHistoryWithMemberInfo

CARMAReturn refreshVersionHistoryWithMemberInfo(org.eclipse.core.runtime.IProgressMonitor pm,
                                                boolean sendNotification,
                                                java.lang.String[] keys,
                                                java.lang.Object[] parameters)
                                                throws org.eclipse.core.runtime.CoreException,
                                                       NotConnectedException,
                                                       UnsupportedCARMAOperationException

The getVersionHistoryWithMemberInfo 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:

Refresh the cache of version history for the resource including a series of member info keys.

Parameters:
pm - progress monitor for the operation
sendNotification - flag indicates if notification should be sent to listeners when changes occur to the version list during update
keys - Member info keys to refresh
parameters - Custom parameters as required by the Repository Manager
Returns:
the custom return response from the method execution
Throws:
org.eclipse.core.runtime.CoreException - An error occurred 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 host
Since:
7.1