View Javadoc

1   package com.leonarduk.clearcheckbook.calls;
2   
3   import org.apache.log4j.Logger;
4   
5   import com.leonarduk.clearcheckbook.ClearCheckBookConnection;
6   import com.leonarduk.clearcheckbook.ClearcheckbookException;
7   import com.leonarduk.clearcheckbook.dto.PremiumDataType;
8   
9   public class PremiumCall extends AbstractCall<PremiumDataType> {
10  
11  	private static final Logger _logger = Logger.getLogger(PremiumCall.class);
12  
13  	public static final String TYPE = "premium";
14  
15  	public PremiumCall(ClearCheckBookConnection connection) {
16  		super(connection, PremiumDataType.class);
17  	}
18  
19  	@Override
20  	protected String getUrlSuffix() {
21  		return TYPE;
22  	}
23  
24  	/***
25  	 * 
26  	 Determines whether or not this user is a premium member. If they are, it
27  	 * returns their custom field flags. <br>
28  	 * Method: get <br>
29  	 * Call: premium
30  	 * <p>
31  	 * Example: <br>
32  	 * https://username:password@www.clearcheckbook.com/api/premium/
33  	 * <p>
34  	 * Parameters: <br>
35  	 * Parameter Required Description <br>
36  	 * None
37  	 * <p>
38  	 * Returned Values: <br>
39  	 * Value Description <br>
40  	 * status true or false. true if the user has a valid premium membership <br>
41  	 * check_num 0 or 1. 1 if the user has the additional check number field
42  	 * enabled <br>
43  	 * memo 0 or 1. 1 if the user has the additional memo field enabled <br>
44  	 * payee 0 or 1. 1 if the user has the additional payee field enabled
45  	 */
46  	@Override
47  	public PremiumDataType get() throws ClearcheckbookException {
48  		PremiumDataType premiumDataType = super.get();
49  		_logger.debug("get:" + premiumDataType);
50  		return premiumDataType;
51  	}
52  }