com.ibm.carma.model
Interface Convertable

All Superinterfaces:
org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier
All Known Subinterfaces:
CARMA, CARMAMember, CARMAMemberVersion

public interface Convertable
extends org.eclipse.emf.ecore.EObject

A representation of the model object 'Convertable'. A CARMA object that supports conversions between the host-side and client-side representation of the item.

The following features are supported:

See Also:
ModelPackage.getConvertable()

Field Summary
static java.lang.String copyright
           
 
Method Summary
 com.ibm.etools.wdz.bidi.IBidiOptions getBidiOptions()
          Returns the value of the 'Bidi Options' containment reference.
 java.io.File getBidiOptionsFile()
          Deprecated. use the com.ibm.etools.wdz.bidi utilities and the get/setBidiOptions methods
 java.lang.String getLocalCodepage()
          Returns the value of the 'Local Codepage' attribute.
 java.lang.String getRemoteCodepage()
          Returns the value of the 'Remote Codepage' attribute.
 boolean isSetBidiOptions()
          Returns whether the value of the 'Bidi Options' containment reference is set.
 boolean isSetBidiOptionsFile()
          Deprecated. 
 boolean isSetLocalCodepage()
          Returns whether the value of the 'Local Codepage' attribute is set.
 boolean isSetRemoteCodepage()
          Returns whether the value of the 'Remote Codepage' attribute is set.
 void setBidiOptions(com.ibm.etools.wdz.bidi.IBidiOptions value)
          Sets the value of the 'Bidi Options' containment reference.
 void setBidiOptionsFile(java.io.File value)
          Deprecated. use com.ibm.etools.wdz.bidi.BidiConversionFile and the setBidiOptions method
 void setLocalCodepage(java.lang.String value)
          Sets the value of the 'Local Codepage' attribute.
 void setRemoteCodepage(java.lang.String value)
          Sets the value of the 'Remote Codepage' attribute.
 void unsetBidiOptions()
          Unsets the value of the 'Bidi Options' containment reference.
 void unsetBidiOptionsFile()
          Deprecated. 
 void unsetLocalCodepage()
          Unsets the value of the 'Local Codepage' attribute.
 void unsetRemoteCodepage()
          Unsets the value of the 'Remote Codepage' attribute.
 
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
 

Field Detail

copyright

static final java.lang.String copyright

See Also:
Constant Field Values
Method Detail

getLocalCodepage

java.lang.String getLocalCodepage()
Returns the value of the 'Local Codepage' attribute. The default value is "UTF-8". The local codepage of the members file contents. The member's file contents will be converted to this codepage from the associated remote codepage

Returns:
the value of the 'Local Codepage' attribute.
See Also:
isSetLocalCodepage(), unsetLocalCodepage(), setLocalCodepage(String), ModelPackage.getConvertable_LocalCodepage()

setLocalCodepage

void setLocalCodepage(java.lang.String value)
Sets the value of the 'Local Codepage' attribute.

Parameters:
value - the new value of the 'Local Codepage' attribute.
See Also:
isSetLocalCodepage(), unsetLocalCodepage(), getLocalCodepage()

unsetLocalCodepage

void unsetLocalCodepage()
Unsets the value of the 'Local Codepage' attribute.

See Also:
isSetLocalCodepage(), getLocalCodepage(), setLocalCodepage(String)

isSetLocalCodepage

boolean isSetLocalCodepage()
Returns whether the value of the 'Local Codepage' attribute is set.

Returns:
whether the value of the 'Local Codepage' attribute is set.
See Also:
unsetLocalCodepage(), getLocalCodepage(), setLocalCodepage(String)

getRemoteCodepage

java.lang.String getRemoteCodepage()
Returns the value of the 'Remote Codepage' attribute. The default value is "037". The remote codepage of the members file contents. The member's file contents will be converted from this codepage to the associated local codepage.

Returns:
the value of the 'Remote Codepage' attribute.
See Also:
isSetRemoteCodepage(), unsetRemoteCodepage(), setRemoteCodepage(String), ModelPackage.getConvertable_RemoteCodepage()

setRemoteCodepage

void setRemoteCodepage(java.lang.String value)
Sets the value of the 'Remote Codepage' attribute.

Parameters:
value - the new value of the 'Remote Codepage' attribute.
See Also:
isSetRemoteCodepage(), unsetRemoteCodepage(), getRemoteCodepage()

unsetRemoteCodepage

void unsetRemoteCodepage()
Unsets the value of the 'Remote Codepage' attribute.

See Also:
isSetRemoteCodepage(), getRemoteCodepage(), setRemoteCodepage(String)

isSetRemoteCodepage

boolean isSetRemoteCodepage()
Returns whether the value of the 'Remote Codepage' attribute is set.

Returns:
whether the value of the 'Remote Codepage' attribute is set.
See Also:
unsetRemoteCodepage(), getRemoteCodepage(), setRemoteCodepage(String)

getBidiOptionsFile

@Deprecated
java.io.File getBidiOptionsFile()
Deprecated. use the com.ibm.etools.wdz.bidi utilities and the get/setBidiOptions methods

Returns the value of the 'Bidi Options File' attribute. BIDI conversion options associated with the file member contents

Returns:
the value of the 'Bidi Options File' attribute.
See Also:
isSetBidiOptionsFile(), unsetBidiOptionsFile(), setBidiOptionsFile(File), ModelPackage.getConvertable_BidiOptionsFile()

setBidiOptionsFile

@Deprecated
void setBidiOptionsFile(java.io.File value)
Deprecated. use com.ibm.etools.wdz.bidi.BidiConversionFile and the setBidiOptions method

Sets the value of the 'Bidi Options File' attribute.

Parameters:
value - the new value of the 'Bidi Options File' attribute.
See Also:
isSetBidiOptionsFile(), unsetBidiOptionsFile(), getBidiOptionsFile()

unsetBidiOptionsFile

@Deprecated
void unsetBidiOptionsFile()
Deprecated. 

Unsets the value of the 'Bidi Options File' attribute.

See Also:
isSetBidiOptionsFile(), getBidiOptionsFile(), setBidiOptionsFile(File)

isSetBidiOptionsFile

@Deprecated
boolean isSetBidiOptionsFile()
Deprecated. 

Returns whether the value of the 'Bidi Options File' attribute is set.

Returns:
whether the value of the 'Bidi Options File' attribute is set.
See Also:
unsetBidiOptionsFile(), getBidiOptionsFile(), setBidiOptionsFile(File)

getBidiOptions

com.ibm.etools.wdz.bidi.IBidiOptions getBidiOptions()
Returns the value of the 'Bidi Options' containment reference. The bidi options to use for CARMA member conversion

Returns:
the value of the 'Bidi Options' containment reference.
See Also:
isSetBidiOptions(), unsetBidiOptions(), setBidiOptions(IBidiOptions), ModelPackage.getConvertable_BidiOptions()

setBidiOptions

void setBidiOptions(com.ibm.etools.wdz.bidi.IBidiOptions value)
Sets the value of the 'Bidi Options' containment reference.

Parameters:
value - the new value of the 'Bidi Options' containment reference.
See Also:
isSetBidiOptions(), unsetBidiOptions(), getBidiOptions()

unsetBidiOptions

void unsetBidiOptions()
Unsets the value of the 'Bidi Options' containment reference.

See Also:
isSetBidiOptions(), getBidiOptions(), setBidiOptions(IBidiOptions)

isSetBidiOptions

boolean isSetBidiOptions()
Returns whether the value of the 'Bidi Options' containment reference is set.

Returns:
whether the value of the 'Bidi Options' containment reference is set.
See Also:
unsetBidiOptions(), getBidiOptions(), setBidiOptions(IBidiOptions)