|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.trackinganalyst.MessageTemplate
public class MessageTemplate
COM Class 'MessageTemplate'. Generated 3/19/2015 1:20:45 PM from 'C:\ArcGIS\COM\esriTrackingAnalyst.olb'
Description 'Controls the properties and methods needed to support Email message content for the Email Alert actions.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =
Field Summary | |
---|---|
static long |
serialVersionUID
|
Fields inherited from interface com.esri.arcgis.trackinganalyst.IMessageTemplate |
---|
IID, IIDd100dbd8_9cc2_4de1_8c26_d030e4b0f938, xxDummy |
Fields inherited from interface com.esri.arcgis.system.IPersistStream |
---|
IID, IID00000109_0000_0000_c000_000000000046, xxDummy |
Fields inherited from interface com.esri.arcgis.system.IPersist |
---|
IID0000010c_0000_0000_c000_000000000046 |
Fields inherited from interface com.esri.arcgis.system.IClone |
---|
IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy |
Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo |
---|
IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy |
Constructor Summary | |
---|---|
MessageTemplate()
Constructs a MessageTemplate using ArcGIS Engine. |
|
MessageTemplate(java.lang.Object obj)
Construct a MessageTemplate using a reference to such an object returned from ArcGIS Engine or Server. |
Method Summary | |
---|---|
void |
assign(IClone src)
Assigns the properties of src to the receiver. |
java.lang.Object |
convertToSupportedObject(int docVersion)
Convert the object to another object that is supported. |
boolean |
equals(java.lang.Object o)
Compare this object with another |
IClone |
esri_clone()
Clones the receiver and assigns the result to *clone. |
java.lang.String |
esri_getSource()
Dataset definition ID associated with the tracking service. |
java.lang.String |
formatMessage(java.lang.Object dataObject)
Generate the formatted message for the data (message or feature) provided. |
void |
getClassID(GUID[] pClassID)
getClassID |
static java.lang.String |
getClsid()
getClsid. |
java.lang.String |
getDateFormat()
Date format to be used for a date field in the message. |
java.lang.Object |
getFieldsWithColumns()
Field names and column index of fields used in the action message. |
com.esri.arcgis.interop.Dispatch |
getJintegraDispatch()
Deprecated. Internal use only. |
void |
getSizeMax(_ULARGE_INTEGER[] pcbSize)
getSizeMax |
int |
getSourceType()
Indication if the source is the dataset definition or a feature. |
java.lang.String |
getTemplate()
Structured message template for use as an action message output. |
java.lang.String |
getTemplateName()
Name of a message template. |
java.lang.String |
getTimeFormat()
Time format to be used for a time field in the message. |
int |
hashCode()
the hashcode for this object |
void |
interfaceSupportsErrorInfo(GUID riid)
interfaceSupportsErrorInfo |
void |
isDirty()
isDirty |
boolean |
isEqual(IClone other)
Indicates if the receiver and other have the same properties. |
boolean |
isIdentical(IClone other)
Indicates if the receiver and other are the same object. |
boolean |
isSupportedAtVersion(int docVersion)
Is this object valid at the given document version. |
void |
load(IStream pstm)
load |
void |
readExternal(java.io.ObjectInput in)
|
void |
release()
Release a MessageTemplate. |
void |
save(IStream pstm,
int fClearDirty)
save |
void |
setDateFormat(java.lang.String dateFormat)
Date format to be used for a date field in the message. |
void |
setFieldsWithColumns(java.lang.Object array)
Field names and column index of fields used in the action message. |
void |
setSource(java.lang.String datasetDefID)
Dataset definition ID associated with the tracking service. |
void |
setSourceType(int type)
Indication if the source is the dataset definition or a feature. |
void |
setTemplate(java.lang.String unformatedMessage)
Structured message template for use as an action message output. |
void |
setTemplateName(java.lang.String name)
Name of a message template. |
void |
setTimeFormat(java.lang.String timeFormat)
Time format to be used for a time field in the message. |
void |
writeExternal(java.io.ObjectOutput out)
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final long serialVersionUID
Constructor Detail |
---|
public MessageTemplate() throws java.io.IOException, java.net.UnknownHostException
java.io.IOException
- if there are interop problems
java.net.UnknownHostException
- if there are interop problemspublic MessageTemplate(java.lang.Object obj) throws java.io.IOException
obj
to MessageTemplate
.
obj
- an object returned from ArcGIS Engine or Server
java.io.IOException
- if there are interop problems
MessageTemplate theMessageTemplate = (MessageTemplate) obj;
Method Detail |
---|
public static java.lang.String getClsid()
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
getJintegraDispatch
in interface com.esri.arcgis.interop.RemoteObjRef
public void release()
release
in interface com.esri.arcgis.interop.RemoteObjRef
public java.lang.String getTemplate() throws java.io.IOException, AutomationException
getTemplate
in interface IMessageTemplate
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTemplate(java.lang.String unformatedMessage) throws java.io.IOException, AutomationException
setTemplate
in interface IMessageTemplate
unformatedMessage
- The unformatedMessage (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getTemplateName() throws java.io.IOException, AutomationException
getTemplateName
in interface IMessageTemplate
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTemplateName(java.lang.String name) throws java.io.IOException, AutomationException
setTemplateName
in interface IMessageTemplate
name
- The name (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getSourceType() throws java.io.IOException, AutomationException
getSourceType
in interface IMessageTemplate
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSourceType(int type) throws java.io.IOException, AutomationException
setSourceType
in interface IMessageTemplate
type
- A com.esri.arcgis.trackinganalyst.enumTemplateSourceType constant (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String esri_getSource() throws java.io.IOException, AutomationException
esri_getSource
in interface IMessageTemplate
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSource(java.lang.String datasetDefID) throws java.io.IOException, AutomationException
setSource
in interface IMessageTemplate
datasetDefID
- The datasetDefID (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String formatMessage(java.lang.Object dataObject) throws java.io.IOException, AutomationException
formatMessage
in interface IMessageTemplate
dataObject
- A reference to another Object (IUnknown) (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getDateFormat() throws java.io.IOException, AutomationException
getDateFormat
in interface IMessageTemplate
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDateFormat(java.lang.String dateFormat) throws java.io.IOException, AutomationException
setDateFormat
in interface IMessageTemplate
dateFormat
- The dateFormat (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getTimeFormat() throws java.io.IOException, AutomationException
getTimeFormat
in interface IMessageTemplate
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTimeFormat(java.lang.String timeFormat) throws java.io.IOException, AutomationException
setTimeFormat
in interface IMessageTemplate
timeFormat
- The timeFormat (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.Object getFieldsWithColumns() throws java.io.IOException, AutomationException
getFieldsWithColumns
in interface IMessageTemplate
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setFieldsWithColumns(java.lang.Object array) throws java.io.IOException, AutomationException
setFieldsWithColumns
in interface IMessageTemplate
array
- A Variant (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void isDirty() throws java.io.IOException, AutomationException
isDirty
in interface IPersistStream
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void load(IStream pstm) throws java.io.IOException, AutomationException
load
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void save(IStream pstm, int fClearDirty) throws java.io.IOException, AutomationException
save
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)fClearDirty
- The fClearDirty (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getSizeMax(_ULARGE_INTEGER[] pcbSize) throws java.io.IOException, AutomationException
getSizeMax
in interface IPersistStream
pcbSize
- A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getClassID(GUID[] pClassID) throws java.io.IOException, AutomationException
getClassID
in interface IPersist
pClassID
- A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IClone esri_clone() throws java.io.IOException, AutomationException
esri_clone
in interface IClone
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void assign(IClone src) throws java.io.IOException, AutomationException
assign
in interface IClone
src
- A reference to a com.esri.arcgis.system.IClone (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isEqual(IClone other) throws java.io.IOException, AutomationException
isEqual
in interface IClone
other
- A reference to a com.esri.arcgis.system.IClone (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isIdentical(IClone other) throws java.io.IOException, AutomationException
isIdentical
in interface IClone
other
- A reference to a com.esri.arcgis.system.IClone (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void interfaceSupportsErrorInfo(GUID riid) throws java.io.IOException, AutomationException
interfaceSupportsErrorInfo
in interface ISupportErrorInfo
riid
- A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isSupportedAtVersion(int docVersion) throws java.io.IOException, AutomationException
Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.
isSupportedAtVersion
in interface IDocumentVersionSupportGEN
docVersion
- A com.esri.arcgis.system.esriArcGISVersion constant (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.Object convertToSupportedObject(int docVersion) throws java.io.IOException, AutomationException
This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.
convertToSupportedObject
in interface IDocumentVersionSupportGEN
docVersion
- A com.esri.arcgis.system.esriArcGISVersion constant (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void writeExternal(java.io.ObjectOutput out) throws java.io.IOException
writeExternal
in interface java.io.Externalizable
java.io.IOException
public void readExternal(java.io.ObjectInput in) throws java.io.IOException, java.lang.ClassNotFoundException
readExternal
in interface java.io.Externalizable
java.io.IOException
java.lang.ClassNotFoundException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |