com.appiancorp.suiteapi.type

Annotation Type Type

@Inherited
 @Documented
 @Retention(value=RUNTIME)
 @Target(value={METHOD,ANNOTATION_TYPE,TYPE,PARAMETER})
public @interface Type

The Type annotation enables one to indicate that the annotated method or parameter is dealing with the specified type. The name and namespace of the type are given as the attributes of the annotation.

The Type annotation can be used with custom smart services and custom functions to indicate the type of the parameters and return values. In most cases, primitive types will be automatically converted to their Appian type equivalent, but in the cases of Appian objects (like Community) a type annotation should be used. Type annotations have been pre-defined for the standard Appian objects (see the See Also list below).

The Type annotation can also be used to indicate that a type is a custom data type:

@Type(namespace="http://example.org", name="MyCustomType")
public void setMyValue(TypedValue v);

The Type annotation can be used to annotate custom pre-defined data type annotations like the ones provided for Appian types. For example:

@Inherited
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Type(namespace="http://example.org", name="MyCustomType")
public @interface MyCustomDataType

See Also:

CommunityDataType, DiscussionMessageDataType, DiscussionThreadDataType, DocumentDataType, DocumentOrFolderDataType, EmailAddressDataType, EmailRecipientDataType, FolderDataType, ForumDataType, GroupDataType, KnowledgeCenterDataType, PageDataType, UserDataType, UserOrGroupDataType, PasswordDataType, ConstantDataType, RuleDataType, EncryptedTextDataType

Field Summary

Fields

Modifier and Type	Fields and Description
static java.lang.String	APPIAN_NAMESPACE

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	name The name attribute is used to indicate the local part (name) of the type.
java.lang.String	namespace The namespace attribute is used to indicate the namespace of the type.

Field Detail

APPIAN_NAMESPACE

public static final java.lang.String APPIAN_NAMESPACE

Element Detail

name

public abstract java.lang.String name

The name attribute is used to indicate the local part (name) of the type.

namespace

public abstract java.lang.String namespace

The namespace attribute is used to indicate the namespace of the type.