Class WritableLog

Description
Description | Methods (details)

Interface WritableLog allows writing of entry items, format types, priority types to a log. Two methods are used to write the entryItems:

  1. appendLog(java.io.Serializable entryItem)
    2.
which writes the entry to the Log,

  1. appendLog(java.io.Serializable entryItem, org.osid.shared.Type
    2. 

  2.  formatType, org.osid.shared.Type priorityType)
    3.
which writes the entryItem to the Log as well as formatType and priorityType.

The implementation sets the timestamp for the for when the entryItem was appended to the log. The format type and the priority type can be set as defaults for subsequent appends.

OSID Version: 2.0

Licensed under the org.osid.SidImplementationLicenseMIT.

Located in /harmoni/oki2/osid/logging/WritableLog.php (line 35) 


	
			







	
	

		
Method Summary

		

			Description |
												Methods (details)
		

		
			
			

								
				

											void
										appendLog
											(object mixed $entryItem)
									

								
				

											void
										appendLogWithTypes
											(object mixed $entryItem, object Type $formatType, mixed $priorityType, object Type $priorityType
)
									

								
				

											void
										assignFormatType
											(mixed $formatType, object Type $formatType
)
									

								
				

											void
										assignPriorityType
											(mixed $priorityType, object Type $priorityType
)
									

								
				

											string
										getDisplayName
										()
									

							

		

	
		

	
	
	

		
Methods

		

			Description |
																Methods (details)
						
		

		

			



	
	

		appendLog (line 84)
	
 
	
	

Write the entryItem to the Log. The entryItem is written to the Log  using the format type and priority type explicitly set by the  application or the implementation default.

	
    
				
  • access: public
    • 
				
  • throws: object LoggingException An exception with one of the          following messages defined in org.osid.logging.LoggingException          may be thrown:   UNIMPLEMENTED,          OPERATION_FAILED, CONFIGURATION_ERROR, PERMISSION_DENIED, PRIORITY_TYPE_NOT_SET, FORMAT_TYPE_NOT_SET, NULL_ARGUMENT
    • 
			

	
	

		void
		
			appendLog
		
					(object mixed $entryItem)
			

	
			
    
					
  • 
				object mixed
				$entryItem: (original type: java.io.Serializable)			
    • 
				

		
		
	




	
	

		appendLogWithTypes (line 111)
	
 
	
	

Write the entry, the priorityType and formatType to the Log.

	
    
				
  • access: public
    • 
				
  • throws: object LoggingException An exception with one of the          following messages defined in org.osid.logging.LoggingException          may be thrown:   UNIMPLEMENTED,          OPERATION_FAILED, CONFIGURATION_ERROR, PERMISSION_DENIED, UNKNOWN_TYPE,          NULL_ARGUMENT
    • 
			

	
	

		void
		
			appendLogWithTypes
		
					(object mixed $entryItem, object Type $formatType, mixed $priorityType, object Type $priorityType
)
			

	
			
    
					
  • 
				object mixed
				$entryItem: (original type: java.io.Serializable)			
    • 
					
  • 
				object Type
				$formatType			
    • 
					
  • 
				object Type
				$priorityType
			
    • 
				

		
		
	




	
	

		assignFormatType (line 163)
	
 
	
	

Assign the formatType for all subsequent writes during the lifetime of  this instance. FormatType has meaning to the caller of this method.

	
    
				
  • access: public
    • 
				
  • throws: object LoggingException An exception with one of the          following messages defined in org.osid.logging.LoggingException          may be thrown:   UNIMPLEMENTED,          OPERATION_FAILED, CONFIGURATION_ERROR, PERMISSION_DENIED, UNKNOWN_TYPE,          NULL_ARGUMENT
    • 
			

	
	

		void
		
			assignFormatType
		
					(mixed $formatType, object Type $formatType
)
			

	
			
		
		
	




	
	

		assignPriorityType (line 137)
	
 
	
	

Assign the priorityType for all subsequent writes during the lifetime of  this instance. PriorityType has meaning to the caller of this method.

	
    
				
  • access: public
    • 
				
  • throws: object LoggingException An exception with one of the          following messages defined in org.osid.logging.LoggingException          may be thrown:   UNIMPLEMENTED,          OPERATION_FAILED, CONFIGURATION_ERROR, PERMISSION_DENIED, UNKNOWN_TYPE,          NULL_ARGUMENT
    • 
			

	
	

		void
		
			assignPriorityType
		
					(mixed $priorityType, object Type $priorityType
)
			

	
			
		
		
	




	
	

		getDisplayName (line 55)
	
 
	
	

Get the display name for this WritableLog.

	
    
				
  • access: public
    • 
				
  • throws: object LoggingException An exception with one of the          following messages defined in org.osid.logging.LoggingException          may be thrown:   UNIMPLEMENTED,          OPERATION_FAILED, CONFIGURATION_ERROR, PERMISSION_DENIED
    • 
			

	
	

		string
		
			getDisplayName
		
				()
			

	
		
		
	

						
		

	



	

		Documentation generated on Wed, 19 Sep 2007 10:28:16 -0400 by phpDocumentor 1.3.0RC3