xlawrence 2005/04/25 15:09:33 CEST
Modified files: (Branch: JAHIA-4-1-BRANCH)
src/java/org/jahia/blogs/actions GetUserBlogsAction.java
src/java/org/jahia/blogs/api BloggerAPI.java
MetaWeblogAPI.java
MovableTypeAPI.java
Log:
updated javadoc comments
Revision Changes Path
1.1.2.3 +1 -2
jahia/src/java/org/jahia/blogs/actions/GetUserBlogsAction.java
http://jahia.mine.nu:8080/cgi-bin/cvsweb.cgi/jahia/src/java/org/jahia/blogs/actions/GetUserBlogsAction.java.diff?r1=1.1.2.2&r2=1.1.2.3&f=h
1.1.2.2 +1 -1 jahia/src/java/org/jahia/blogs/api/BloggerAPI.java
http://jahia.mine.nu:8080/cgi-bin/cvsweb.cgi/jahia/src/java/org/jahia/blogs/api/BloggerAPI.java.diff?r1=1.1.2.1&r2=1.1.2.2&f=h
1.1.2.2 +1 -1 jahia/src/java/org/jahia/blogs/api/MetaWeblogAPI.java
http://jahia.mine.nu:8080/cgi-bin/cvsweb.cgi/jahia/src/java/org/jahia/blogs/api/MetaWeblogAPI.java.diff?r1=1.1.2.1&r2=1.1.2.2&f=h
1.1.2.2 +79 -27 jahia/src/java/org/jahia/blogs/api/MovableTypeAPI.java
http://jahia.mine.nu:8080/cgi-bin/cvsweb.cgi/jahia/src/java/org/jahia/blogs/api/MovableTypeAPI.java.diff?r1=1.1.2.1&r2=1.1.2.2&f=h
Index: GetUserBlogsAction.java
===================================================================
RCS file:
/home/cvs/repository/jahia/src/java/org/jahia/blogs/actions/Attic/GetUserBlogsAction.java,v
retrieving revision 1.1.2.2
retrieving revision 1.1.2.3
diff -u -r1.1.2.2 -r1.1.2.3
--- GetUserBlogsAction.java 15 Apr 2005 09:32:02 -0000 1.1.2.2
+++ GetUserBlogsAction.java 25 Apr 2005 13:09:32 -0000 1.1.2.3
@@ -88,8 +88,6 @@
*/
public Object execute() throws JahiaException {
- Vector result = new Vector();
-
// Create commmon resources
super.init();
@@ -105,6 +103,7 @@
pageDef.getID());
Enumeration blogPagesIdEnum = blogPagesId.elements();
+ Vector result = new Vector();
// For each page matching the Blog definition
while (blogPagesIdEnum.hasMoreElements()) {
Index: BloggerAPI.java
===================================================================
RCS file:
/home/cvs/repository/jahia/src/java/org/jahia/blogs/api/Attic/BloggerAPI.java,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -u -r1.1.2.1 -r1.1.2.2
--- BloggerAPI.java 14 Apr 2005 13:24:01 -0000 1.1.2.1
+++ BloggerAPI.java 25 Apr 2005 13:09:33 -0000 1.1.2.2
@@ -190,7 +190,7 @@
* Returns the main or archive index template of a given blog.
*
* @param appKey Unique identifier/passcode of the application sending
the post
- * @param blogid Unique identifier of the blog the post will be added to
+ * @param blogID Unique identifier of the blog the post will be added to
* @param userName Login for a user who has permission to post to the
blog
* @param password Password for given userName
* @param templateType Determines which of the blog's templates will be
Index: MetaWeblogAPI.java
===================================================================
RCS file:
/home/cvs/repository/jahia/src/java/org/jahia/blogs/api/Attic/MetaWeblogAPI.java,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -u -r1.1.2.1 -r1.1.2.2
--- MetaWeblogAPI.java 14 Apr 2005 13:26:21 -0000 1.1.2.1
+++ MetaWeblogAPI.java 25 Apr 2005 13:09:33 -0000 1.1.2.2
@@ -54,7 +54,7 @@
/**
* Authenticates a user and returns the categories available in the
website
*
- * @param blogid Unique identifier of the blog to get the categories from
+ * @param blogID Unique identifier of the blog to get the categories from
* @param userName Login for a user who has permission to post to the
blog
* @param password Password for given username
*
Index: MovableTypeAPI.java
===================================================================
RCS file:
/home/cvs/repository/jahia/src/java/org/jahia/blogs/api/Attic/MovableTypeAPI.java,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -u -r1.1.2.1 -r1.1.2.2
--- MovableTypeAPI.java 21 Apr 2005 08:18:41 -0000 1.1.2.1
+++ MovableTypeAPI.java 25 Apr 2005 13:09:33 -0000 1.1.2.2
@@ -42,7 +42,7 @@
import org.apache.xmlrpc.XmlRpcException;
/**
- * Movable Type adds a couple of other methods (to the MetawebLog API) of
its
+ * Movable Type adds a couple of other methods (to the MetawebLog API) of its
* own for manipulating the categories assigned to your entries.
*
* @author Xavier Lawrence
@@ -50,72 +50,124 @@
public interface MovableTypeAPI extends MetaWeblogAPI {
/**
- * Returns a bandwidth-friendly list of the most recent posts in the
system.
+ * Returns a bandwidth-friendly list of the most recent posts in the
system.
+ *
+ * @param blogID Unique identifier of the blog to get the post titles
from
+ * @param userName Login for a user who has permission to post to the
blog
+ * @param passWord Password for given username
+ * @param numberOfPosts Number of Post titles to Retrieve
+ *
+ * @return A Vector of Hashtables containing dateCreated, userid, postid
+ * and title
+ * @throws XmlRpcException If something goes wrong
*/
public Vector getRecentPostTitles(
- final String blogID,
+ final String blogID,
final String userName,
- final String passWord,
- final int numberOfPosts)
+ final String passWord,
+ final int numberOfPosts)
throws XmlRpcException;
/**
- * Returns a list of all categories defined in the weblog.
+ * Returns a list of all categories defined in the weblog.
+ *
+ * @param blogID Unique identifier of the blog to get the categories from
+ * @param userName Login for a user who has permission to post to the
blog
+ * @param passWord Password for given username
+ *
+ * @return A Vector of Hashtables containing categoryId and categoryName
+ * @throws XmlRpcException If something goes wrong
*/
public Vector getCategoryList(
- final String blogID,
+ final String blogID,
final String userName,
- final String passWord)
+ final String passWord)
throws XmlRpcException;
/**
- * Returns a list of all categories to which the post is assigned.
+ * Returns a list of all categories to which the post is assigned.
+ *
+ * @param postID Unique identifier of the post to get the categories from
+ * @param userName Login for a user who has permission to post to the
blog
+ * @param passWord Password for given username
+ *
+ * @return A Vector of Hashtables containing categoryId, categoryName and
+ * isPrimary
+ * @throws XmlRpcException If something goes wrong
*/
- public Vector getPostCategories(
- final String postID,
+ public Vector getPostCategories(
+ final String postID,
final String userName,
- final String passWord)
+ final String passWord)
throws XmlRpcException;
/**
- * Sets the categories for a post.
+ * Sets the categories for a post.
+ *
+ * @param postID Unique identifier of the post to set the categories
+ * @param userName Login for a user who has permission to post to the
blog
+ * @param passWord Password for given username
+ * @param categories Vector of hashtables containing categoryId and
categoryName
+ *
+ * @return true if the operation was successful
+ * @throws XmlRpcException If something goes wrong
*/
public boolean setPostCategories(
- final String postID,
+ final String postID,
final String userName,
- final String passWord,
- final Vector categories)
+ final String passWord,
+ final Vector categories)
throws XmlRpcException;
/**
* Retrieve information about the XML-RPC methods supported by the
server.
+ *
+ * @return a Vector of method names supported by the server
+ * @throws XmlRpcException If something goes wrong
*/
public Vector supportedMethods() throws XmlRpcException;
/**
- * Retrieve information about the text formatting plugins supported by
- * the server.
+ * Retrieve information about the text formatting plugins supported by
+ * the server.
+ *
+ * @return a Vector of supported Text Filters supported by the server
+ * @throws XmlRpcException If something goes wrong
*/
public Vector supportedTextFilters() throws XmlRpcException;
/**
- * Retrieve the list of TrackBack pings posted to a particular entry.
- * This could be used to programmatically retrieve the list of pings for
a
- * particular entry, then iterate through each of those pings doing the
same,
- * until one has built up a graph of the web of entries referencing one
- * another on a particular topic.
+ * Retrieve the list of TrackBack pings posted to a particular entry.
+ * This could be used to programmatically retrieve the list of pings for
a
+ * particular entry, then iterate through each of those pings doing the
same,
+ * until one has built up a graph of the web of entries referencing one
+ * another on a particular topic.
+ *
+ * @param postID Unique identifier of the post to get the TrackBakc
Pings from
+ *
+ * @return a Vector of Hashtables containing pingTitle (the title of the
+ * entry sent in the ping), pingURL (the URL of the entry),
+ * and pingIP (the IP address of the host that sent the ping).
+ * @throws XmlRpcException If something goes wrong
*/
public Vector getTrackbackPings(
- final String postID)
+ final String postID)
throws XmlRpcException;
/**
- * Publish (rebuild) all of the static files related to an entry from
your
- * weblog. Equivalent to saving an entry in the system (but without the
ping).
+ * Publish (rebuild) all of the static files related to an entry from
your
+ * weblog. Equivalent to saving an entry in the system (but without the
ping).
+ *
+ * @param blogID Unique identifier of the blog to publish the posts
+ * @param userName Login for a user who has permission to post to the
blog
+ * @param passWord Password for given username
+ *
+ * @return true if the operation was successful
+ * @throws XmlRpcException If something goes wrong
*/
public boolean publishPost(
final String blogID,
final String userName,
final String passWord)
- throws XmlRpcException;
+ throws XmlRpcException;
}
