org.sandev.basics.structs
Interface SandStructMessage

All Superinterfaces:

SandInstanceMessage, SandMessage

All Known Subinterfaces:

AuthUser, BaseUserInterface, IODeclBaseInterface, SandPersistMessage

All Known Implementing Classes:

AggregateUpdate, AuthWrapper, BaseUser, BaseUserEmail, CacheAction, CacheItemSummary, CacheMemSummary, CacheStats, Configuration, DataImportExport, ErrorInfo, IODeclBase, IODeclCall, IODeclReceive, IODeclSend, IODeclSubscribe, MessageDescription, Ping, ServerDeclaration, Stats, StringValue, TestAction, TestCondition, TestNodeParamChange, TestRunStatus, TestScript, TestStep, UIDisplayDirective, UIFormContext, UIFormControl, UIFormInitializer, UIFormQuery

public interface SandStructMessage
extends SandInstanceMessage

Interface to identify instance messages that inherit from structs.

SandMessage

SandInstanceMessage
SandStructMessage
SandPersistMessage
NodeInstance
SandTransmitMessage
SandVerbMessage
SandUpdateMessage
SandQueryMessage
SandCollectionMessage

Field Summary

Fields inherited from interface org.sandev.basics.structs.SandInstanceMessage

FIELDCHECK_EMPTYSTRINGPRINTVAL, FIELDCHECK_INVALIDVAL, FIELDCHECK_NOTAREF, FIELDCHECK_NOTINRANGE, FIELDCHECK_NULLARRAY, FIELDCHECK_STRINGOVER, FIELDCHECK_UNKNOWNVAL, FIELDFLAG_BINARY, FIELDFLAG_ENCRYPT, FIELDFLAG_INTERNAL, FIELDFLAG_NOECHO, FIELDFLAG_OBFUSCATE, FIELDFLAG_STRINGPERSIST, FIELDFLAG_SUMMARYEDIT, FIELDFLAG_UNIQUE, GENMOD_ACTION_APPEND, GENMOD_ACTION_INSERT, GENMOD_ACTION_REMOVE, GENMOD_ACTION_SET

Method Summary

SandCollectionMessage	find(SandQueryMessage sqm) Return a matching collection of all directly contained instances matching the given query.
SandPersistMessage	getInstance(java.lang.String classname, long id) If this instance directly contains the specified instance, then find it and return it.
SandInstanceMessage	getInstance(java.lang.String classname, java.lang.String fieldname, java.lang.String value) If this instance directly contains the specified instance, then find it and return it.
java.lang.String	getPrintname() Return the declared printname for this message class.

Methods inherited from interface org.sandev.basics.structs.SandInstanceMessage

cloneMessage, convertToSuperstructClass, copyFieldValue, debugDump, defaultField, fieldHasFlag, fieldsValid, fieldValidate, generalAccessor, generalDereference, generalModifier, getAllFields, getContainedMessageFields, getDisplayFields, getDisplayFieldsPrint, getDisplayID, getDisplayValues, getLayoutXML, getPrintnameForField

Methods inherited from interface org.sandev.basics.structs.SandMessage

getBaseMemoryUse, getCollectionMessage, getQueryMessage, getShortName, getStructMessage, getUpdateMessage, isEquivalent

Method Detail

getPrintname

java.lang.String getPrintname()

Return the declared printname for this message class.

getInstance

SandPersistMessage getInstance(java.lang.String classname,
                               long id)

If this instance directly contains the specified instance, then find it and return it. Returns null if not found.

getInstance

SandInstanceMessage getInstance(java.lang.String classname,
                                java.lang.String fieldname,
                                java.lang.String value)

If this instance directly contains the specified instance, then find it and return it. Returns null if not found.

find

SandCollectionMessage find(SandQueryMessage sqm)

Return a matching collection of all directly contained instances matching the given query.