KSOAP.java

package com.kedzie.vbox.soap;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.ksoap2.serialization.SoapSerializationEnvelope;

/**
 * Specifies marshalling into SOAP Envelope.
 * Can be applied to
 * 
 * <dl>
 * <dt>Arguments</dt>
 * <dd>
 * <ul>
 * <li>Specify the SOAP property name</li>
 * <li>Specify Namespace or Datatype of marshalled parameter
 * i.e. <code>@KSOAP(namespace=SoapSerializationEnvelope.XSD, type="unsigned_int", value="timeout")</code>
 * </ul>
 * </dd>
 * 
 * <dt>Method</dt>
 * <dd>
 * <ul>
 * <li>SOAP method prefix and name</li>
 * <li>Whether the return value is stored in the In-Memory Cache (<code>@KSOAP(cacheable=true)</code>)</li>
 * </ul>
 * </dd>
 * @apiviz.landmark
 */
@Target({ElementType.PARAMETER, ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface KSOAP {
	public String value() default "";
	public String namespace() default SoapSerializationEnvelope.XSD;
	public String type() default "";
	public String prefix() default "";
	public String thisReference() default "_this";
	public boolean cacheable() default false;
}